ifw-fcf  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
fcf::devmgr::common::DeviceControllerData Struct Reference

The DeviceControllerData struct. More...

#include <deviceLcsIf.hpp>

Inheritance diagram for fcf::devmgr::common::DeviceControllerData:
fcf::devmgr::actuator::ActuatorControllerData fcf::devmgr::adc::AdcControllerData fcf::devmgr::lamp::LampControllerData fcf::devmgr::motor::MotorControllerData fcf::devmgr::piezo::PiezoControllerData fcf::devmgr::sensor::SensorControllerData fcf::devmgr::shutter::ShutterControllerData fcf::devmgr::drot::DrotControllerData

Public Member Functions

 DeviceControllerData ()
 
virtual ~DeviceControllerData ()
 
int GetState () const
 
void SetState (int state)
 
int GetSubstate () const
 
std::string GetStateStr () const
 
void SetSubstate (int subtate)
 
bool GetLocalFlag () const
 
void SetLocalFlag (bool local_flag)
 
int GetErrorCode () const
 
void SetErrorCode (int error_code)
 
void SetData (const DeviceControllerData &data)
 

Protected Attributes

int m_state
 
int m_substate
 
bool m_local
 
int m_error_code
 

Detailed Description

The DeviceControllerData struct.

This structure is used store the basic information about a device. Devices classes will read the device information from the controller and it will store it in this structure.

Constructor & Destructor Documentation

fcf::devmgr::common::DeviceControllerData::DeviceControllerData ( )
fcf::devmgr::common::DeviceControllerData::~DeviceControllerData ( )
virtual

Member Function Documentation

int fcf::devmgr::common::DeviceControllerData::GetErrorCode ( ) const
inline
bool fcf::devmgr::common::DeviceControllerData::GetLocalFlag ( ) const
inline
int fcf::devmgr::common::DeviceControllerData::GetState ( ) const
inline
std::string fcf::devmgr::common::DeviceControllerData::GetStateStr ( ) const
inline
int fcf::devmgr::common::DeviceControllerData::GetSubstate ( ) const
inline
void fcf::devmgr::common::DeviceControllerData::SetData ( const DeviceControllerData data)
void fcf::devmgr::common::DeviceControllerData::SetErrorCode ( int  error_code)
inline
void fcf::devmgr::common::DeviceControllerData::SetLocalFlag ( bool  local_flag)
inline
void fcf::devmgr::common::DeviceControllerData::SetState ( int  state)
inline
void fcf::devmgr::common::DeviceControllerData::SetSubstate ( int  subtate)
inline

Member Data Documentation

int fcf::devmgr::common::DeviceControllerData::m_error_code
protected
bool fcf::devmgr::common::DeviceControllerData::m_local
protected
int fcf::devmgr::common::DeviceControllerData::m_state
protected
int fcf::devmgr::common::DeviceControllerData::m_substate
protected

The documentation for this struct was generated from the following files: