ifw-fcf  5.0.0-pre2
adcLcsIf.hpp
Go to the documentation of this file.
1 
9 #ifndef FCF_DEVMGR_DEVICE_ADC_IF_HPP
10 #define FCF_DEVMGR_DEVICE_ADC_IF_HPP
11 
12 #include <unordered_map>
13 
14 #include <yaml-cpp/yaml.h>
18 
19 namespace fcf::devmgr::adc {
20 
29  public:
31  virtual ~AdcControllerData();
32 
33  void SetData(const AdcControllerData& data);
34 
35  inline virtual std::string GetErrorText() const;
36  inline virtual std::string GetSubstateStr() const;
37 
38  inline short GetTrackingMode() const;
39  inline std::string GetTrackingModeStr() const;
40  inline void SetTrackingMode(short mode);
41 
42  inline double GetAlpha() const;
43  inline void SetAlpha(double alpha);
44 
45  inline double GetDelta() const;
46  inline void SetDelta(double delta);
47 
49 
50  inline void ClearMotors();
51 
52  inline void AddMotor(const std::string motor,
54 
55  inline void GetMotorNames(std::vector<std::string>& motor_vector);
56 
57  protected:
58  short m_tracking_mode {};
59  double m_alpha {};
60  double m_delta {};
61 
62  std::map<std::string, fcf::devmgr::motor::MotorControllerData> m_motors;
63  };
64 
65 
66 
81 
82  // enumerations for Adc status
83  enum {
84  STAT_LOCAL = 100,
85  STAT_ERROR = 101,
86  STAT_STATE = 102,
87  STAT_SUBSTATE = 103,
88  STAT_TRACK_MODE = 104,
89  STAT_ALPHA = 105,
90  STAT_DELTA = 106
91  };
92 
93  public:
102  AdcLcsIf(std::shared_ptr<fcf::devmgr::common::IDeviceConfig> config,
104 
108  virtual ~AdcLcsIf() {};
109 
118  virtual void InitObject();
119 
125  virtual void Init();
126 
127  void UpdateTargetPosition(int axis_id, double position, std::string move_type);
134  void MoveAbs(int axis_id, double position, double velocity);
135 
142  void MoveRel(int axis_id, double position, double velocity);
143 
144  void MoveEncAbs(int axis_id, long int encoders);
145 
146  void MoveEncRel(int axis_id, long int encoders);
156  void MoveVel(int axis_id, double velocity);
157 
158 
159 
165  void StartTrack(const double& angle);
166 
170  void StopTrack();
171 
176  void MoveAngle(const double& angle);
177 
182  bool IsTracking() const;
183 
188  bool IsMoving() const;
189 
195  bool IsInPosition(const int axis = -1) const;
196 
201  bool IsStandstill() const;
202 
203 
209  void ReadConfig();
210 
211  std::string GetMotorMapValue(std::string motor, std::string category, std::string key);
212 
213 
214 
215 
224  virtual void ReadStatus(AdcControllerData& status);
225 
226  void StartTrackMonitoring();
227  void StopTrackMonitoring();
228 
240  void Listener(protocol::base::VectorVariant& params);
241 
247  virtual std::string GetRpcError(const short error_code) const;
248 
249  protected:
250 
255  void LoadConfig();
256 
257  private:
258 
259 
267  void StoreMotorPosition(const std::string nodeid_prefix,
268  const protocol::base::Variant& value,
269  int attribute);
270 
271  void StoreMotorAttribute(const std::string nodeid_prefix,
272  const protocol::base::Variant& value,
273  int attribute);
274 
275  void MovePos(int axis_id, double position, double velocity,
276  std::string move_type=fcf::devmgr::motor::RPC_MOVE_ABS);
277 
278  protected:
280  std::vector<std::string> m_monitor_track_vector;
281  //std::map<std::string, int> m_motor_index;
285  std::unique_ptr<elt::configng::CiiConfigDocument> m_motor_map_doc;
286 
287  double m_mot_actual_pos {0.0};
288  double m_mot_actual_pos_axis[2] {0.0,0.0};
289  double m_alpha {};
290  double m_delta {};
291  short m_track_mode {};
292 
293  std::map<std::string, fcf::devmgr::motor::MotorControllerData> m_motors_status;
294 
295  private:
296  log4cplus::Logger m_logger;
297  };
298 
299 }
300 
301 #include "adcLcsIf.ipp"
302 
303 #endif //FCF_DEVMGR_DEVICE_ADC_IF_HPP
AdcConfig class header file.
Adc Local Control System (LCS) Interface (IF) class.
Definition: adcLcsIf.hpp:80
void StopTrackMonitoring()
Definition: adcLcsIf.cpp:557
void MoveEncRel(int axis_id, long int encoders)
Definition: adcLcsIf.cpp:293
void LoadConfig()
Load the YAML configuration.
double m_mot_actual_pos
Definition: adcLcsIf.hpp:287
void MoveRel(int axis_id, double position, double velocity)
Executes the MoveRel RPC.
Definition: adcLcsIf.cpp:271
virtual std::string GetRpcError(const short error_code) const
Definition: adcLcsIf.cpp:637
bool IsMoving() const
IsMoving.
Definition: adcLcsIf.cpp:583
std::vector< std::string > m_monitor_track_vector
Special monitor vector of attributes to be monitored only in tracking mode.
Definition: adcLcsIf.hpp:280
std::map< std::string, fcf::devmgr::motor::MotorControllerData > m_motors_status
Definition: adcLcsIf.hpp:293
void Listener(protocol::base::VectorVariant &params)
Callback to manage changes on the monitored items.
Definition: adcLcsIf.cpp:667
virtual void InitObject()
Initialize object.
Definition: adcLcsIf.cpp:52
double m_alpha
Definition: adcLcsIf.hpp:289
void MoveAngle(const double &angle)
MoveAngle.
Definition: adcLcsIf.cpp:474
virtual void Init()
Executes the Init RPC.
Definition: adcLcsIf.cpp:163
void StartTrackMonitoring()
Definition: adcLcsIf.cpp:544
void MoveAbs(int axis_id, double position, double velocity)
Executes the MoveAbs RPC.
Definition: adcLcsIf.cpp:261
void StopTrack()
StopTrack.
Definition: adcLcsIf.cpp:447
void MoveVel(int axis_id, double velocity)
Executes the MoveVel RPC.
Definition: adcLcsIf.cpp:305
std::unique_ptr< elt::configng::CiiConfigDocument > m_motor_map_doc
Config document for mapping file.
Definition: adcLcsIf.hpp:285
void UpdateTargetPosition(int axis_id, double position, std::string move_type)
Definition: adcLcsIf.cpp:232
void MoveEncAbs(int axis_id, long int encoders)
Definition: adcLcsIf.cpp:281
void ReadConfig()
Read the configuration.
std::string GetMotorMapValue(std::string motor, std::string category, std::string key)
Definition: adcLcsIf.cpp:392
virtual ~AdcLcsIf()
Default destructor.
Definition: adcLcsIf.hpp:108
void StartTrack(const double &angle)
Start ADC tracking.
Definition: adcLcsIf.cpp:413
bool IsTracking() const
IsTracking.
Definition: adcLcsIf.cpp:569
double m_delta
Definition: adcLcsIf.hpp:290
short m_track_mode
Definition: adcLcsIf.hpp:291
virtual void ReadStatus(AdcControllerData &status)
Read status from the controller.
Definition: adcLcsIf.cpp:516
double m_mot_actual_pos_axis[2]
Definition: adcLcsIf.hpp:288
bool IsStandstill() const
IsStandstill.
Definition: adcLcsIf.cpp:628
AdcLcsIf(std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config, fcf::devmgr::common::DataContext &data_ctx)
adcLcsIf constructor.
Definition: adcLcsIf.cpp:43
bool IsInPosition(const int axis=-1) const
IsInPosition.
Definition: adcLcsIf.cpp:598
Definition: dataContext.hpp:90
Definition: deviceLcsIf.hpp:77
DataContext class header file.
drotLcsIf class header file.
Definition: adc.cpp:20
constexpr auto RPC_MOVE_ABS
Definition: motorBaseConfig.hpp:51
Definition: __init__.py:1
The adcControllerData struct.
Definition: adcLcsIf.hpp:28
void AddMotor(const std::string motor, const fcf::devmgr::motor::MotorControllerData motor_data)
AdcControllerData()
Definition: adcLcsIf.cpp:23
double m_alpha
Definition: adcLcsIf.hpp:59
virtual std::string GetSubstateStr() const
void GetMotorNames(std::vector< std::string > &motor_vector)
short m_tracking_mode
Definition: adcLcsIf.hpp:58
virtual std::string GetErrorText() const
std::string GetTrackingModeStr() const
void SetData(const AdcControllerData &data)
Definition: adcLcsIf.cpp:35
std::map< std::string, fcf::devmgr::motor::MotorControllerData > m_motors
Definition: adcLcsIf.hpp:62
virtual ~AdcControllerData()
Definition: adcLcsIf.cpp:32
double m_delta
Definition: adcLcsIf.hpp:60
fcf::devmgr::motor::MotorControllerData GetMotor(std::string motor) const
The DeviceControllerData struct.
Definition: deviceLcsIf.hpp:36
The MotorControllerData struct.
Definition: motorLcsIf.hpp:34