ifw-fcf  5.0.0-pre2
motorBaseLcsIf.hpp
Go to the documentation of this file.
1 
9 #ifndef FCF_DEVMGR_DEVICE_MOTOR_BASE_IF_HPP
10 #define FCF_DEVMGR_DEVICE_MOTOR_BASE_IF_HPP
11 
12 // System headers
13 #include <unordered_map>
14 
15 // Third party headers
16 #include <yaml-cpp/yaml.h>
17 
21 
22 #include <Fcfif.hpp>
23 #include <rad/mal/publisher.hpp>
24 
25 namespace fcf::devmgr::motor {
26 
35  public:
37  virtual ~MotorBaseControllerData();
38 
39  inline double GetActualPos() const;
40  inline void SetActualPos(double position);
41  inline double GetPosError() const;
42  inline void SetPosError(double pos_error);
43  inline double GetActualVel() const;
44  inline void SetActualVel(double velocity);
45  inline double GetTargetPos() const;
46  inline void SetTargetPos(double position);
47  inline double GetTargetVel() const;
48  inline void SetTargetVel(double velocity);
49  inline virtual std::string GetSubstateStr() const;
50 
51  protected:
52  double m_target_pos {};
53  double m_actual_pos {};
54  double m_pos_error {};
55  double m_actual_vel {};
56  double m_target_vel {};
57  double m_scale_factor {1};
58 
59  };
60 
75  {
76  public:
77  enum {
90  };
91 
92  public:
93 
102  MotorBaseLcsIf(std::shared_ptr<fcf::devmgr::common::IDeviceConfig> config,
104 
108  virtual ~MotorBaseLcsIf() {};
109 
116  void MoveAbs(double position);
117 
125  void MoveEncAbs(int encoders);
126 
133  void MoveRel(double position);
134 
142  void MoveEncRel(int encoders);
143 
151  void MoveByName(std::string namedpos);
152 
160  void MoveVel(double velocity);
161 
166  virtual bool IsDisabling();
167 
172  bool IsMoving() const;
173 
178  bool IsStandstill() const;
179 
184  bool IsInPosition() const;
185 
190  bool IsMovingInRightDirection() const;
191 
192  void SetTargetNamedPosition(const std::string named_position);
193  const std::string GetTargetNamedPosition();
194 
195  protected:
196  void MovePos(double position, double velocity, std::string move_type=RPC_MOVE_ABS);
197 
198 
199 
200  protected:
201 
202  //std::unique_ptr<rad::cii::Publisher<fcfif::MotorPositionTopic>> m_motor_publisher;
203  //std::unique_ptr<rad::cii::Publisher<TOPIC_TYPE>> m_publisher;
204 
205  double m_mot_actual_pos {0.0};
206  double m_mot_actual_enc {0.0};
207  std::string m_mot_target_name {""};
208  std::string m_mot_actual_name {""};
209  double m_mot_target_pos {0.0};
210  double m_mot_pos_error {0.0};
211  double m_mot_target_vel {0.0};
212  double m_mot_actual_vel {0.0};
213  double m_mot_scale {1.0};
214  bool m_mot_initialised {false};
215 
216 
217  private:
218  log4cplus::Logger m_logger;
219 
220 
221  };
222 
223 }
224 
225 #include "motorBaseLcsIf.ipp"
226 
227 #endif //FCF_DEVMGR_DEVICE_MOTOR_BASE_IF_HPP
Definition: dataContext.hpp:90
Definition: deviceLcsIf.hpp:77
Motor Local Control System (LCS) Interface (IF) class.
Definition: motorBaseLcsIf.hpp:75
virtual bool IsDisabling()
Check if controller is disabling the motor.
Definition: motorBaseLcsIf.cpp:140
virtual ~MotorBaseLcsIf()
Default destructor.
Definition: motorBaseLcsIf.hpp:108
double m_mot_target_pos
Definition: motorBaseLcsIf.hpp:209
@ STAT_HW_STATUS
Definition: motorBaseLcsIf.hpp:80
@ STAT_TARGET_VEL
Definition: motorBaseLcsIf.hpp:87
@ STAT_INITIALISED
Definition: motorBaseLcsIf.hpp:88
@ STAT_STATE
Definition: motorBaseLcsIf.hpp:81
@ STAT_TARGET_POS
Definition: motorBaseLcsIf.hpp:84
@ STAT_LOCAL
Definition: motorBaseLcsIf.hpp:78
@ STAT_POS_ERROR
Definition: motorBaseLcsIf.hpp:85
@ STAT_ACTUAL_VEL
Definition: motorBaseLcsIf.hpp:86
@ STAT_MOTOR_BASE_END
Definition: motorBaseLcsIf.hpp:89
@ STAT_ERROR
Definition: motorBaseLcsIf.hpp:79
@ STAT_ACTUAL_POS
Definition: motorBaseLcsIf.hpp:83
@ STAT_SUBSTATE
Definition: motorBaseLcsIf.hpp:82
double m_mot_pos_error
Definition: motorBaseLcsIf.hpp:210
double m_mot_actual_pos
Definition: motorBaseLcsIf.hpp:205
std::string m_mot_target_name
Definition: motorBaseLcsIf.hpp:207
double m_mot_actual_enc
Definition: motorBaseLcsIf.hpp:206
void MovePos(double position, double velocity, std::string move_type=RPC_MOVE_ABS)
Definition: motorBaseLcsIf.cpp:103
bool IsInPosition() const
Check if motor is in position.
Definition: motorBaseLcsIf.cpp:208
void MoveEncRel(int encoders)
Executes the MoveRel RPC.
Definition: motorBaseLcsIf.cpp:72
void MoveRel(double position)
Executes the MoveRel RPC.
Definition: motorBaseLcsIf.cpp:46
MotorBaseLcsIf(std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config, fcf::devmgr::common::DataContext &data_ctx)
MotorLcsIf constructor.
Definition: motorBaseLcsIf.cpp:21
void MoveByName(std::string namedpos)
Executes the MovePos RPC.
Definition: motorBaseLcsIf.cpp:85
std::string m_mot_actual_name
Definition: motorBaseLcsIf.hpp:208
void MoveAbs(double position)
Executes the MoveAbs RPC.
Definition: motorBaseLcsIf.cpp:33
bool m_mot_initialised
Definition: motorBaseLcsIf.hpp:214
double m_mot_actual_vel
Definition: motorBaseLcsIf.hpp:212
bool IsMoving() const
Check if motor is moving.
Definition: motorBaseLcsIf.cpp:183
bool IsStandstill() const
Check if motor is on.
Definition: motorBaseLcsIf.cpp:198
void SetTargetNamedPosition(const std::string named_position)
Definition: motorBaseLcsIf.cpp:237
double m_mot_target_vel
Definition: motorBaseLcsIf.hpp:211
double m_mot_scale
Definition: motorBaseLcsIf.hpp:213
void MoveEncAbs(int encoders)
Executes the MoveAbs RPC.
Definition: motorBaseLcsIf.cpp:59
void MoveVel(double velocity)
Executes the MoveVel RPC.
Definition: motorBaseLcsIf.cpp:148
bool IsMovingInRightDirection() const
Check if motor is moving in the right direction.
Definition: motorBaseLcsIf.cpp:222
const std::string GetTargetNamedPosition()
Definition: motorBaseLcsIf.cpp:244
DataContext class header file.
deviceLcsIf class header file.
MotorConfig class header file.
Definition: motor.hpp:18
constexpr auto RPC_MOVE_ABS
Definition: motorBaseConfig.hpp:51
The DeviceControllerData struct.
Definition: deviceLcsIf.hpp:36
The MotorBaseControllerData struct.
Definition: motorBaseLcsIf.hpp:34
virtual ~MotorBaseControllerData()
Definition: motorBaseLcsIf.cpp:16
MotorBaseControllerData()
Definition: motorBaseLcsIf.cpp:4
double m_actual_pos
Definition: motorBaseLcsIf.hpp:53
double m_pos_error
Definition: motorBaseLcsIf.hpp:54
double m_scale_factor
Definition: motorBaseLcsIf.hpp:57
double m_target_pos
Definition: motorBaseLcsIf.hpp:52
virtual std::string GetSubstateStr() const
double m_target_vel
Definition: motorBaseLcsIf.hpp:56
double m_actual_vel
Definition: motorBaseLcsIf.hpp:55