ifw-fcf 7.1.4
Loading...
Searching...
No Matches
motorBaseLcsIf.hpp
Go to the documentation of this file.
1
7#ifndef FCF_DEVMGR_DEVICE_MOTOR_BASE_IF_HPP
8#define FCF_DEVMGR_DEVICE_MOTOR_BASE_IF_HPP
9
10#include <unordered_map>
11
12#include <yaml-cpp/yaml.h>
13
17
18#include <Fcfif.hpp>
19#include <rad/mal/publisher.hpp>
20
21
23
32 public:
35
36 inline double GetActualPos() const;
37 inline void SetActualPos(double position);
38 inline double GetPosError() const;
39 inline void SetPosError(double pos_error);
40 inline double GetActualVel() const;
41 inline void SetActualVel(double velocity);
42 inline double GetTargetPos() const;
43 inline void SetTargetPos(double position);
44 inline double GetTargetVel() const;
45 inline void SetTargetVel(double velocity);
46 inline std::string GetUserUnit() const;
47 inline void SetUserUnit(const std::string& unit);
48 inline virtual std::string GetSubstateStr() const;
49
50 private:
51 double m_target_pos {};
52 double m_actual_pos {};
53 double m_pos_error {};
54 double m_actual_vel {};
55 double m_target_vel {};
56 double m_scale_factor {1};
57 std::string m_user_unit {""};
58
59 };
60
75 {
76 public:
77 enum {
91 };
92
93 public:
94
103 MotorBaseLcsIf(std::shared_ptr<ifw::fcf::devmgr::common::IDeviceConfig> config,
105
109 virtual ~MotorBaseLcsIf() {};
110
117 void MoveAbs(double position, ::fcfif::MotorPosUnit unit = ::fcfif::MotorPosUnit::UU);
118
126 void MoveEncAbs(int encoders);
127
134 void MoveRel(double position, ::fcfif::MotorPosUnit unit = ::fcfif::MotorPosUnit::UU);
135
143 void MoveEncRel(int encoders);
144
152 void MoveByName(std::string namedpos);
153
161 void MoveVel(double velocity);
162
167 virtual bool IsDisabling() const;
168
173 bool IsMoving() const;
174
179 bool IsStandstill() const;
180
185 bool IsInPosition() const;
186
191 bool IsMovingInRightDirection() const;
192
193 void SetTargetNamedPosition(const std::string named_position);
194 const std::string GetTargetNamedPosition();
195
196 std::optional<double> GetTargetInUserUnits(double value);
197
198 protected:
199 void MovePos(double position, double velocity, std::string move_type=RPC_MOVE_ABS);
200
201
202
203 protected:
204
205 //std::unique_ptr<rad::cii::Publisher<fcfif::MotorPositionTopic>> m_motor_publisher;
206 //std::unique_ptr<rad::cii::Publisher<TOPIC_TYPE>> m_publisher;
207
208 double m_mot_actual_pos {0.0}; // NOLINT(misc-non-private-member-variables-in-classes)
209 double m_mot_actual_enc {0.0}; // NOLINT(misc-non-private-member-variables-in-classes)
210 std::string m_mot_target_name {""}; // NOLINT(misc-non-private-member-variables-in-classes)
211 std::string m_mot_actual_name {""}; // NOLINT(misc-non-private-member-variables-in-classes)
212 double m_mot_target_pos {0.0}; // NOLINT(misc-non-private-member-variables-in-classes)
213 double m_mot_pos_error {0.0}; // NOLINT(misc-non-private-member-variables-in-classes)
214 double m_mot_target_vel {0.0}; // NOLINT(misc-non-private-member-variables-in-classes)
215 double m_mot_actual_vel {0.0}; // NOLINT(misc-non-private-member-variables-in-classes)
216 double m_mot_scale {1.0}; // NOLINT(misc-non-private-member-variables-in-classes)
217 bool m_mot_initialised {false}; // NOLINT(misc-non-private-member-variables-in-classes)
218 std::string m_mot_user_unit {""}; // NOLINT(misc-non-private-member-variables-in-classes)
219
220
221 private:
222 log4cplus::Logger m_logger;
223
224
225 };
226
227}
228
229#include "motorBaseLcsIf.ipp"
230
231#endif //FCF_DEVMGR_DEVICE_MOTOR_BASE_IF_HPP
Definition dataContext.hpp:86
Definition deviceLcsIf.hpp:84
Motor Local Control System (LCS) Interface (IF) class.
Definition motorBaseLcsIf.hpp:75
std::optional< double > GetTargetInUserUnits(double value)
Definition motorBaseLcsIf.cpp:66
bool m_mot_initialised
Definition motorBaseLcsIf.hpp:217
double m_mot_actual_enc
Definition motorBaseLcsIf.hpp:209
@ STAT_INITIALISED
Definition motorBaseLcsIf.hpp:88
@ STAT_STATE
Definition motorBaseLcsIf.hpp:81
@ STAT_HW_STATUS
Definition motorBaseLcsIf.hpp:80
@ STAT_ACTUAL_VEL
Definition motorBaseLcsIf.hpp:86
@ STAT_USER_UNIT
Definition motorBaseLcsIf.hpp:89
@ STAT_TARGET_VEL
Definition motorBaseLcsIf.hpp:87
@ STAT_SUBSTATE
Definition motorBaseLcsIf.hpp:82
@ STAT_ACTUAL_POS
Definition motorBaseLcsIf.hpp:83
@ STAT_POS_ERROR
Definition motorBaseLcsIf.hpp:85
@ STAT_LOCAL
Definition motorBaseLcsIf.hpp:78
@ STAT_TARGET_POS
Definition motorBaseLcsIf.hpp:84
@ STAT_MOTOR_BASE_END
Definition motorBaseLcsIf.hpp:90
@ STAT_ERROR
Definition motorBaseLcsIf.hpp:79
MotorBaseLcsIf(std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig > config, ifw::fcf::devmgr::common::DataContext &data_ctx)
MotorLcsIf constructor.
Definition motorBaseLcsIf.cpp:57
double m_mot_actual_pos
Definition motorBaseLcsIf.hpp:208
std::string m_mot_user_unit
Definition motorBaseLcsIf.hpp:218
bool IsInPosition() const
Check if motor is in position.
Definition motorBaseLcsIf.cpp:289
double m_mot_scale
Definition motorBaseLcsIf.hpp:216
void MoveEncAbs(int encoders)
Executes the MoveAbs RPC.
Definition motorBaseLcsIf.cpp:139
void MoveEncRel(int encoders)
Executes the MoveRel RPC.
Definition motorBaseLcsIf.cpp:152
void MovePos(double position, double velocity, std::string move_type=RPC_MOVE_ABS)
Definition motorBaseLcsIf.cpp:183
virtual ~MotorBaseLcsIf()
Default destructor.
Definition motorBaseLcsIf.hpp:109
bool IsMoving() const
Check if motor is moving.
Definition motorBaseLcsIf.cpp:264
void MoveVel(double velocity)
Executes the MoveVel RPC.
Definition motorBaseLcsIf.cpp:227
void SetTargetNamedPosition(const std::string named_position)
Definition motorBaseLcsIf.cpp:318
double m_mot_actual_vel
Definition motorBaseLcsIf.hpp:215
std::string m_mot_target_name
Definition motorBaseLcsIf.hpp:210
double m_mot_target_vel
Definition motorBaseLcsIf.hpp:214
virtual bool IsDisabling() const
Check if controller is disabling the motor.
Definition motorBaseLcsIf.cpp:219
double m_mot_target_pos
Definition motorBaseLcsIf.hpp:212
std::string m_mot_actual_name
Definition motorBaseLcsIf.hpp:211
void MoveByName(std::string namedpos)
Executes the MovePos RPC.
Definition motorBaseLcsIf.cpp:165
void MoveRel(double position, ::fcfif::MotorPosUnit unit=::fcfif::MotorPosUnit::UU)
Executes the MoveRel RPC.
Definition motorBaseLcsIf.cpp:112
void MoveAbs(double position, ::fcfif::MotorPosUnit unit=::fcfif::MotorPosUnit::UU)
Executes the MoveAbs RPC.
Definition motorBaseLcsIf.cpp:86
double m_mot_pos_error
Definition motorBaseLcsIf.hpp:213
bool IsStandstill() const
Check if motor is on.
Definition motorBaseLcsIf.cpp:279
const std::string GetTargetNamedPosition()
Definition motorBaseLcsIf.cpp:325
bool IsMovingInRightDirection() const
Check if motor is moving in the right direction.
Definition motorBaseLcsIf.cpp:303
Motor class source file.
Definition motor.hpp:17
constexpr auto RPC_MOVE_ABS
Definition motorBaseConfig.hpp:46
The DeviceControllerData struct.
Definition deviceLcsIf.hpp:42
The MotorBaseControllerData struct.
Definition motorBaseLcsIf.hpp:31
virtual ~MotorBaseControllerData()
Definition motorBaseLcsIf.cpp:52
void SetUserUnit(const std::string &unit)
MotorBaseControllerData()
Definition motorBaseLcsIf.cpp:40