ifw  0.0.1-dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Namespaces | Macros | Enumerations | Functions | Variables
{{cookiecutter.device_name}}LcsIf.hpp File Reference

{{cookiecutter.device_name}}LcsIf class header file. More...

#include <unordered_map>
#include <yaml-cpp/yaml.h>
#include "devmgr/common/deviceLcsIf.hpp"
#include "devmgr/devices/{{cookiecutter.device_name}}Config.hpp"
#include "devmgr/common/dataContext.hpp"
#include "{{cookiecutter.device_name|lower}}LcsIf.inline"

Go to the source code of this file.

Namespaces

 devmgr
 

Macros

#define DEVMGR_DEVICE_   {{cookiecutter.device_name|upper}}_IF_HPP
 

Enumerations

enum  { devmgr::STAT_LOCAL = 1, devmgr::STAT_ERROR = 2, devmgr::STAT_STATE = 3, devmgr::STAT_SUBSTATE = 4 }
 

Functions

virtual bool devmgr::IsReady ()
 {{cookiecutter.device_name}}LcsIf constructor. More...
 
virtual bool devmgr::IsOperational ()
 Check if controller is in Operational. More...
 
virtual virtual void devmgr::ReadConfig ()
 DeviceConfig constructor. More...
 
bool devmgr::IsHwFailure ()
 Check if {{cookiecutter.device_name|capitalize()}} is in hardware error. More...
 
virtual void devmgr::ReadStatus ({{cookiecutter.device_name|capitalize()}}ControllerData &status)
 Read status from the controller. More...
 
void devmgr::StartMonitoring ()
 Start monitoring of controller attributes. More...
 
void devmgr::StopMonitoring ()
 Stop monitoring of controller attributes. More...
 
void devmgr::Listener (fcf::common::VectorVariant &params)
 Callback to manage changes on the monitored items. More...
 
virtual std::string devmgr::GetRpcError (const short error_code) const
 
virtual std::string devmgr::GetHwError ()
 Get error message. More...
 

Variables

class {
devmgr::enum
 {{cookiecutter.device_name|capitalize()}} Local Control System (LCS) Interface (IF) class More...
 
std::unordered_map
< std::string, short > 
devmgr::m_status_map
 
devmgr::common::DataContextdevmgr::m_data_ctx
 reference to the data context. More...
 

Detailed Description

{{cookiecutter.device_name}}LcsIf class header file.

Author
{{cookiecutter.device_author}}

Macro Definition Documentation

#define DEVMGR_DEVICE_   {{cookiecutter.device_name|upper}}_IF_HPP