view/rangesCtrl/UrgCtrl.h

#ifndef URG_CTRL_H
#define URG_CTRL_H

/*!
  \file
  \brief URG 制御

  \author Satofumi KAMIMURA

  $Id$

  \todo タイムスタンプまわりを、timestampAdjust/ に移動させる
*/

#include "RangeSensorInterface.h"
#include <memory>

namespace beego {
  class ConnectionInterface;
  class SensorParameter;

  /*!
    \brief SCIP2.0 規格による URG 制御
  */
  class UrgCtrl : public RangeSensorInterface {
    UrgCtrl(const UrgCtrl& rhs);
    UrgCtrl& operator = (const UrgCtrl& rhs);

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

  public:
    enum {
      DefaultBaudrate = 115200,        //!< デフォルトボーレート

      VEND = 0,                        //!< ベンダ情報
      PROD,                        //!< 製品情報
      FIRM,                        //!< ファームウェアバージョン
      PROT,                        //!< プロトコルバージョン
      SERI,                        //!< センサ固有シリアル番号
    };

    /*!
      \brief データの取得形式
    */
    typedef enum {
      ManualCapture,                //!< 逐次取得
      AutoCapture,                //!< 自動取得
    } CaptureMode;

    UrgCtrl(void);
    ~UrgCtrl(void);
    const char* what(void);

    /*!
      \brief 接続

      引数を解析しての接続処理。以下のオプションを解析可能

      - --urg_port=<port> ... 接続ポートを指定
      - --urg_baudrate=<port> ... 接続ボーレートを指定
      - --urg_handstand ... URG の取得データの配置を開始と終了で反転させる

      \retval true 接続成功
      \retval false 接続に失敗
    */
    bool connect(int argc, char* argv[]);
    bool connect(const char* device, long baudrate = DefaultBaudrate);
    bool connect(ConnectionInterface* con);
    void disconnect(void);
    bool isConnected(void);

    /*!
      \brief バージョン情報の文字列を返す

      \param lines [o] バージョン情報の文字列

      \todo もう少し詳しく記述する。具体例も交えて
    */
    bool getVersionInfo(std::vector<std::string>& lines);

    long getMinDistance(void) const;
    long getMaxDistance(void) const;

    // !!! Length っていう名前は、サイズを連想しにくいので、改名しましょう
    int getMaxDataLength(void) const;

    /*!
      \brief データ取得

      データ取得を行い、バッファに格納する

      \param data [o] 取得データ用バッファ
      \param max_size [i] 取得データ用バッファの最大サイズ

      \return 取得データ数
      \retval < 0 取得失敗
    */
    int capture(long data[], size_t max_size);

    // 角度変換
    double index2rad(const int index) const;
    int rad2index(const double radian) const;

    /*!
      \brief タイムスタンプの調整

      getTimestamp() で返されるタイムスタンプについて、このメソッドを評価した瞬間の値が、set_value の値になるように設定する

      \param set_value [i] タイムスタンプ基準値の設定値

      \todo 説明がわかりにくいのを、なんとかする。図が必要かも
    */
    void adjustTimestamp(int set_value = 0);

    /*!
      \brief PC 時刻で調整したタイムスタンプの取得

      \attention capture() 後でなければ、この値は無効
    */
    long getTimestamp(void);

    /*!
      \brief センサパラメータの取得

      \todo 説明する
    */
    bool loadSensorParameter(SensorParameter* parameter);

    /*!
      \brief センサパラメータの設定

      \todo 説明する
    */
    void setSensorParameter(const SensorParameter* parameter);

    /*!
      \brief 取得データを反転させる

      \param on [i] 反転させるとき true

      \todo 説明がわかりにくい。図があった方がよい

      \attention 真面目に動作確認をしてないかも...。使い方によっては問題か？
    */
    void setHandstand(bool on = true);

    /*!
      \brief 取得モードの設定

      \param mode [i] 取得モード設定 (AutoCapture / ManualCapture)

      \code
      UrgCtrl urg;
      urg.setCaptureMode(UrgCtrl::AutoCapture);
      \endcode

      取得モードの詳細は \ref compare_auto_manual_page を参照のこと。
    */
    void setCaptureMode(CaptureMode mode);

    int getCaptureMode(void);

    /*!
      \brief 取得バッファ数の設定

      内部に格納できるバッファ(周期データ数)を設定

      \param size [i] バッファ数

      \todo 概念図を用いて説明する
    */
    void setMaxBufferNum(size_t size);

    // フレームの間引き回数
    void setFrameSkipFrames(size_t skip_frames);

    /*!
      \brief データをまとめるグループ数

      \param [i] groups まとめるグループ数

      \todo ちゃんと説明する
    */
    void setDataGroups(size_t groups);

    // 取得範囲の指定
    void setCaptureRange(int first_index, int last_index);

    /*!
      \brief レーザの出力制御

      \param on [i] true のとき、レーザ出力を ON
    */
    void setLaserOutput(bool on);

    /*!
      \brief データ取得の開始
    */
    void startCaptures(void);

    /*!
      \brief データ取得の開始
    */
    void stopCaptures(void);

    // 直前 capture() 時のタイムスタンプを返す
    unsigned long getRawTimestamp(void);

    /*!
      \brief 測距の周期時間を取得

      \return 測距の周期時間
    */
    int getScanMsec(void);

    ConnectionInterface* getConnection(void);
  };
};

#endif /* !URG_CTRL_H */