view/connection/ConnectionDeviceSearch.h

#ifndef CONNECTION_DEVICE_SEARCH_H
#define CONNECTION_DEVICE_SEARCH_H

#include <string>


/*!
  \page connection_device_search_page シリアル ID 指定のデバイス探索

  \section connection_device_search_section_abst 概要

  シリアル ID 指定にて、接続するデバイスを探し出すための機能。デバイスによって、以下のどちらかが利用可能。
    - デバイスにシリアル ID を指定し、個体判別まで可能なクラス
    - 製品にシリアル ID がないため、そのデバイスかの判別まで可能なクラス

  \n
  \section connection_device_search_section_list 利用可能なデバイス用クラス
  - シリアル ID を利用した個体判別までが可能なクラス
    - UrgCtrl (URG, Top-URG)
  \n \n
  - デバイスの判別までが可能なクラス
    - RunCtrl
    - Pgm238Ctrl
    - Tds01vCtrl

  \n
  \section connection_device_search_section_usage 使い方

  URG を例に、利用方法を説明します。URG の場合、デバイス判別をするためのクラスとして、UrgIdHandler を用います。

  -# デバイスのシリアル ID を確認する (参考 \ref miniterm_page)
\verbatim
% miniterm
VV
V
00P
VEND:Hokuyo Automatic Co.,Ltd.
PROD:SOKUIKI Sensor URG-04LX
FIRM:0.2.72g,06/06/02(20-5500[mm],240[deg],44-725[step],600[rpm])
PROT:00003,(SCIP 2.0)
SERI:H0614967
STAT:FW-dt WF:22mErCheck[FinDis with shadow   ]
\endverbatim
  \n
  このデバイスのシリアル ID は「H0614967」であることがわかります。
  \n \n
  -# デバイス検出のプログラム内で、シリアル ID 指定でデバイスを探索する
  \include urgIdHandlerSample.cpp
*/


/*!
  \file
  \brief 製品番号による接続

  \author Satofumi KAMIMURA

  $Id$
*/

#include <memory>
#include <vector>

namespace beego {

  class ConnectionInterface;
  class ProductIdHandler;


  /*!
    \brief 接続デバイスの探索クラス

    登録しておいたデバイスの中から、対象デバイスを探索する。
  */
  class ConnectionDeviceSearch {
    ConnectionDeviceSearch(const ConnectionDeviceSearch& rhs);
    ConnectionDeviceSearch& operator = (const ConnectionDeviceSearch& rhs);

    struct pImpl;
    const std::auto_ptr<pImpl> pimpl;

  public:
    ConnectionDeviceSearch(void);
    ~ConnectionDeviceSearch(void);

    /*!
      \brief 接続候補デバイスの登録

      \param device[i] 接続候補デバイス名
    */
    void add(const char* device);

    /*!
      \brief 接続候補デバイス名の登録削除

      \param device [i] 登録削除するデバイス名

      \attention 探索で一致したデバイス名は候補から削除されるため、ユーザ側から動的に削除する必要はない。
    */
    void remove(const char* device);

    /*!
      \brief 接続候補デバイスのクリア
    */
    void clear(void);

    /*!
      \brief 未割り当ての接続候補デバイスを返す

      \param devices [o] 未割り当ての接続候補デバイス

      \return 未割り当ての接続候補デバイスの個数
    */
    size_t getLeftDevices(std::vector<std::string>& devices);

    /*!
      \brief 接続候補デバイスの探索

      \param find_device [o] 一致したデバイス名
      \param handler [i] 探索を行うデバイスのハンドラ
      \param productId [i] 探索したいデバイスのシリアル ID

      \retval true 探索に成功。find_device に見つかったデバイス名を代入して返す
      \retval false 探索失敗
    */
    bool search(std::string& find_device, const ProductIdHandler* handler,
                const char* productId = "");

    /*!
      \brief 接続候補のデバイス登録数

      \return 接続候補のデバイス登録数
    */
    size_t size(void);
  };
};

#endif /* !CONNECTION_DEVICE_SEARCH_H */