view/runCtrl/RunCtrl.h

#ifndef RUN_CTRL_H
#define RUN_CTRL_H

/*!
  \file
  \brief 走行制御ライブラリ

  \author Satofumi KAMIMURA

  \todo 車輪が逆回転できるかの設定を導入する
  \todo 旋回半径の設定関数を導入する

  \todo 自己位置の取得方法を、どうするか考える
  \todo 返される自己位置を 3D で返させる

  $Id$
*/

#include "RunCtrlInterface.h"
#include "FollowLineInterface.h"
#include "GetPositionInterface.h"
#include "DirectWheelCtrlInterface.h"
#include <memory>
#include <cstddef>


namespace beego {
  /*!
    \brief 走行制御クラス
  */
  class RunCtrl : public RunCtrlInterface,
                  public FollowLineInterface,
                  public GetPositionInterface,
                  public DirectWheelCtrlInterface {
    RunCtrl(const RunCtrl& rhs);
    RunCtrl& operator = (const RunCtrl& rhs);

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

  public:
    enum {
      DefaultBaudrate = 115200,
      LeftWheel = 0,
      RightWheel,
    };
    RunCtrl(void);
    ~RunCtrl(void);
    const char* what(void);

    // システムコマンド
    bool connect(int argc, char *argv[]);
    bool connect(const char* device, long baudrate = DefaultBaudrate);
    bool connect(ConnectionInterface* con);
    void disconnect(void);
    bool isConnected(void);
    ConnectionInterface*& getConnection(void);

    void set_sendRetryTimes(size_t times);
    void set_recvTimeout(size_t msec);
    void set_watchDogTimer(size_t msec);

    // !!! 旋回半径を定義するコマンド

    void push_runState(void);
    void pop_runState(void);

    // 移動コマンド
    void stop(void);
    void set_servoFree(void);

    // !!! Position でなく、Line 型を定義して利用可能にする
    void follow_line(const CoordinateCtrl* crd, const Position<int>& position);
    void follow_circle(const CoordinateCtrl* crd,
                       const Grid<int>& point, const int radius);

    // !!! 並進速度を下げてでも、経路通りに走行するコマンドを追加する
    // !!! 直線
    // !!! 円弧

    // !!! line がまぎらわしい。端っこまで移動、というニュアンスの単語に変える
    // !!! また、停止線は、２点で指定できるようにもしたい
    // !!! stop_toLine() なら、まだわかるかも
    void stop_toLine(const CoordinateCtrl* crd,
                     const Position<int>& position);

    // !!! どういう動きをするのか、わからない
    // !!! 目標位置に向かう、でいいのかな？
    // !!! 直線追従 + 速度制御
    void stop_toPoint(const CoordinateCtrl* crd, const Grid<int>& point);

    // !!! 指定距離以上だけ動作するのか？ どういう動きなのかわからない。
    // !!! 直線移動 + 停止、なんだろうけど...
    // !!! もっとわかりやすい名前にする
    // !!! 直線移動についてのパラメータ指定がないのも気になる
    void move_length(const int length);

    void rotate_angle(const Angle& angle);

    // !!! stop_toAngle() にすべきか？
    void stop_toAngle(const CoordinateCtrl* crd, const Angle& angle);

    //void getParams_
    //void setParams_

    // !!! 接線指定の円弧追従
    // !!! 速度指定の回転
    // !!! 直前の移動コマンドを再発行

    // 判定コマンド
    // !!! 以下のコマンドは、getPosition() から作りましょう。別ファイルにて
    bool isStable(void);
    int getLength_toLine(const CoordinateCtrl* crd,
                         const Position<int>& position);
    int getLength_toPoint(const CoordinateCtrl* crd, const Grid<int>& point);

    Angle getAngle_toDirection(void);
    Angle getAngle_toPoint(void);
    Angle getAngle_toLine(void);

    int getVelocityDiff_straight(const int velocity);
    Angle getVelocityDiff_rotate(const Angle velocity);

    int getVelocity_straight(void);
    Angle getVelocity_rotate(void);

    // 座標系コマンド
    // !!!
    // !!! ここで自己位置を取得する
    Position<int> getPosition(const CoordinateCtrl* crd = NULL);

    // パラメータ操作コマンド
    //GetParams getParams;
    // !!!

    //SetParams setParams;
    // !!!

    size_t getRawTimestamp(void);

    // デバイスの直接制御コマンド
    // !!! PWM の直接制御
    // !!! モータモードの直接制御
    // !!! エンコーダ値の直接取得
    void direct_setWheelVelocity(const int id, const int velocity_mm);

    void direct_setStraightVelocity(const int velocity_mm);
    void direct_setRotateVelocity(const Angle& velocity_angle);
  };
};

#endif /* !RUN_CTRL_H */