ControlFunctions.hh

[詳解]

 
//
// Copyright (C) 2011-2024 Yokokura, Yuki
// MIT License. For details, see the LICENSE file.
 
#ifndef CONTROL_FUNCTIONS
#define CONTROL_FUCNTIONS
 
#include <array>
#include <functional>
#include "ConstParams.hh"
#include "InterfaceFunctions.hh"
#include "UserPlot.hh"
 
// 前方宣言
namespace ARCS{
    class ARCSmemory;
    class ARCSscrparams;
    class ARCSgraphics;
}
 
namespace ARCS {    // ARCS名前空間
class ControlFunctions {
    public:
        enum CtrlFuncMode {
            CTRL_INIT,  
            CTRL_LOOP,  
            CTRL_EXIT   
        };
        
        ControlFunctions(ARCSscrparams& SP, ARCSgraphics& GP, ARCSmemory& DM)
            : Screen(SP),           // 画面パラメータへの参照
                Graph(GP),          // グラフィックスへの参照
                Memory(DM),         // データメモリへの参照
                Interface(),        // インターフェースクラスの初期化
                UsrGraph(GP),       // ユーザカスタムプロットクラスの初期化
                CmdFlag(CTRL_INIT), // 動作モード設定フラグの初期化
                CtrlFuncObj(),      // 各制御用周期実行関数の関数オブジェクト配列の初期化
                count(0),           // ループカウンタの初期化
                NetworkLink(false), // ネットワークリンクフラグの初期化
                Initializing(false) // ロボット初期化フラグの初期化
        {
            PassedLog();    // イベントログにココを通過したことを記録
            
            // 各制御用周期実行関数の関数オブジェクトを格納 (実時間スレッド生成に必要な作業)
            CtrlFuncObj[0] = [&](const double t, const double Tact, const double Tcmp){ return ControlFunction1(t, Tact, Tcmp); };  // ラムダ式でメンバ関数を返す
            CtrlFuncObj[1] = [&](const double t, const double Tact, const double Tcmp){ return ControlFunction2(t, Tact, Tcmp); };  // ラムダ式でメンバ関数を返す
            CtrlFuncObj[2] = [&](const double t, const double Tact, const double Tcmp){ return ControlFunction3(t, Tact, Tcmp); };  // ラムダ式でメンバ関数を返す
            
            PassedLog();    // イベントログにココを通過したことを記録
        }
        
        ~ControlFunctions(){
            PassedLog();    // イベントログにココを通過したことを記録
        }
        
        void InitialProcess(void){
            PassedLog();        // イベントログにココを通過したことを記録
            // 初期化モードでの各制御用周期実行関数の実行
            CmdFlag = CTRL_INIT;// フラグを初期化モードに設定して，
            for(size_t i = 0; i < ConstParams::THREAD_NUM; ++i) CtrlFuncObj[i](0, 0, 0);    // 各々の制御関数(関数の配列)を実行
            CmdFlag = CTRL_LOOP;// フラグを周期モードに設定
            PassedLog();        // イベントログにココを通過したことを記録
        }
        
        void ExitProcess(void){
            PassedLog();        // イベントログにココを通過したことを記録
            // 終了処理モードでの各制御用周期実行関数の実行
            CmdFlag = CTRL_EXIT;// フラグを終了処理モードに設定して，
            for(size_t i = 0; i < ConstParams::THREAD_NUM; ++i) CtrlFuncObj[i](0, 0, 0);    // 各々の制御関数(関数の配列)を実行
            PassedLog();        // イベントログにココを通過したことを記録
        }
        
        void UpdateControlValue(void);      
        
        std::array<std::function<bool(const double, const double, const double)>, ARCSparams::THREAD_MAX>
        GetCtrlFuncObject(void) const{
            return CtrlFuncObj;
        }
        
    private:
        ControlFunctions(const ControlFunctions&) = delete;                 
        const ControlFunctions& operator=(const ControlFunctions&) = delete;
        
        ARCSscrparams& Screen;          
        ARCSgraphics& Graph;            
        ARCSmemory& Memory;             
        InterfaceFunctions Interface;   
        UserPlot UsrGraph;              
        CtrlFuncMode CmdFlag;           
        std::array< std::function<bool(const double, double, const double)>, ARCSparams::THREAD_MAX> CtrlFuncObj;   
        unsigned long count;            
        bool NetworkLink;               
        bool Initializing;              
        
        // 制御用周期実行関数群
        // 以下の関数は初期化モード若しくは終了処理モードのときに非実時間空間上で動作する
        // 周期モードのときは実時間スレッド( SFthread.cc の RealTimeThread関数 ) から関数ポインタを経由して，以下の関数が呼ばれる
        bool ControlFunction1(const double t, const double Tact, const double Tcmp);    
        bool ControlFunction2(const double t, const double Tact, const double Tcmp);    
        bool ControlFunction3(const double t, const double Tact, const double Tcmp);    
};
}
 
#endif