ifw-fcf 7.1.4
Loading...
Searching...
No Matches
actuatorLcsIf.hpp
Go to the documentation of this file.
1
8#ifndef DEVMGR_DEVICE_ACTUATOR_IF_HPP
9#define DEVMGR_DEVICE_ACTUATOR_IF_HPP
10
11#include <unordered_map>
12
13#include <yaml-cpp/yaml.h>
17
18#include <Fcfif.hpp>
19#include <rad/mal/publisher.hpp>
20
21namespace ifw::fcf::devmgr {
22 namespace actuator {
23
32 public:
35
36 inline std::string GetErrorText() const;
37 void SetData(const ActuatorControllerData& data);
38
39 inline virtual std::string GetSubstateStr() const;
40
41 protected:
42
43 };
44
45
60 {
61
62 // enumerations for actuator status
63 enum {
64 STAT_LOCAL = 1,
65 STAT_ERROR = 2,
66 STAT_HW_STATUS = 3,
67 STAT_STATE = 4,
68 STAT_SUBSTATE = 5,
69 };
70
71 public:
80 ActuatorLcsIf(std::shared_ptr<ifw::fcf::devmgr::common::IDeviceConfig> config,
82
86 virtual ~ActuatorLcsIf() = default;
87
96 virtual void InitObject();
97
102 virtual bool IsNotReady() const noexcept;
103
108 virtual bool IsReady() const noexcept;
109
114 virtual bool IsOperational() const noexcept;
115
122 void SwitchOn();
123
130 void SwitchOff();
131
136 bool IsSwitchingOn() const noexcept;
137
142 bool IsSwitchingOff() const noexcept;
143
144
149 bool IsOn() const noexcept;
150
155 bool IsOff() const noexcept;
156
165 virtual void ReadStatus(ActuatorControllerData& status);
166
167
179 void Listener(ifw::core::protocol::base::VectorVariant& params);
180
186 virtual std::string GetRpcError(const short error_code) const;
187
188
189 private:
190 log4cplus::Logger m_logger;
191
192
193 };
194 }
195}
196
197#include "actuatorLcsIf.ipp"
198
199#endif //DEVMGR_DEVICE_ACTUATOR_IF_HPP
actuator Local Control System (LCS) Interface (IF) class
Definition actuatorLcsIf.hpp:60
bool IsOff() const noexcept
Check if switch is off.
Definition actuatorLcsIf.cpp:207
virtual bool IsOperational() const noexcept
Check if controller is in Operational.
Definition actuatorLcsIf.cpp:145
ActuatorLcsIf(std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig > config, ifw::fcf::devmgr::common::DataContext &data_ctx)
actuatorLcsIf constructor.
Definition actuatorLcsIf.cpp:40
virtual std::string GetRpcError(const short error_code) const
Definition actuatorLcsIf.cpp:240
void SwitchOff()
Executes the SwitchOff RPC.
Definition actuatorLcsIf.cpp:83
void Listener(ifw::core::protocol::base::VectorVariant &params)
Callback to manage changes on the monitored items.
Definition actuatorLcsIf.cpp:230
bool IsSwitchingOff() const noexcept
Check if controller is switching the switch off.
Definition actuatorLcsIf.cpp:178
virtual bool IsReady() const noexcept
Check if controller is in Standby/Ready state.
Definition actuatorLcsIf.cpp:127
void SwitchOn()
Executes the SwitchOn RPC.
Definition actuatorLcsIf.cpp:57
bool IsSwitchingOn() const noexcept
Check if controller is switching the switch on.
Definition actuatorLcsIf.cpp:163
virtual void ReadStatus(ActuatorControllerData &status)
Read status from the controller.
Definition actuatorLcsIf.cpp:221
bool IsOn() const noexcept
Check if switch is on.
Definition actuatorLcsIf.cpp:194
virtual bool IsNotReady() const noexcept
Check if controller is in Standby/NotReady state.
Definition actuatorLcsIf.cpp:108
virtual void InitObject()
Initialize object.
Definition actuatorLcsIf.cpp:47
virtual ~ActuatorLcsIf()=default
Default destructor.
Definition dataContext.hpp:86
Definition deviceLcsIf.hpp:84
actuatorLcsIf class header file.
Definition actionMgr.cpp:28
Definition actionMgr.cpp:28
The actuatorControllerData struct.
Definition actuatorLcsIf.hpp:31
virtual ~ActuatorControllerData()
Definition actuatorLcsIf.cpp:33
ActuatorControllerData()
Definition actuatorLcsIf.cpp:29
void SetData(const ActuatorControllerData &data)
Definition actuatorLcsIf.cpp:36
The DeviceControllerData struct.
Definition deviceLcsIf.hpp:42
std::string const
Definition test{{cookiecutter.device_name|capitalize()}}.cpp:161