ifw-fcf  5.0.0-pre2
Public Member Functions | Protected Attributes | List of all members
fcf::devmgr::lamp::LampControllerData Struct Reference

The LampControllerData struct. More...

#include <lampLcsIf.hpp>

Inheritance diagram for fcf::devmgr::lamp::LampControllerData:
fcf::devmgr::actuator::ActuatorControllerData fcf::devmgr::common::DeviceControllerData

Public Member Functions

 LampControllerData ()
 
virtual ~LampControllerData ()
 
double GetIntensity () const
 
unsigned int GetTimeLeft () const
 
int GetAnalogFeedback () const
 
bool GetOnAnalog () const
 
bool GetOnDigital () const
 
void SetIntensity (double intensity)
 
void SetTimeLeft (unsigned int time_left)
 
void SetAnalogFeedback (int feedback)
 
void SetOnAnalog (bool on_analog)
 
void SetOnDigital (bool on_digital)
 
std::string GetErrorText () const
 
virtual std::string GetSubstateStr () const
 
void SetData (const LampControllerData &data)
 
- Public Member Functions inherited from fcf::devmgr::actuator::ActuatorControllerData
 ActuatorControllerData ()
 
virtual ~ActuatorControllerData ()
 
std::string GetErrorText () const
 
void SetData (const ActuatorControllerData &data)
 
- Public Member Functions inherited from fcf::devmgr::common::DeviceControllerData
 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

double m_intensity
 
unsigned int m_time_left
 
int m_analog_feedback
 
bool m_on_analog
 
bool m_on_digital
 
- Protected Attributes inherited from fcf::devmgr::common::DeviceControllerData
int m_state
 
int m_substate
 
bool m_local
 
int m_error_code
 

Detailed Description

The LampControllerData struct.

This structure is used store the status information about the lamp. The LampLcsIf class will read the lamp status information from the controller and it will store it in this structure.

Constructor & Destructor Documentation

◆ LampControllerData()

fcf::devmgr::lamp::LampControllerData::LampControllerData ( )

◆ ~LampControllerData()

fcf::devmgr::lamp::LampControllerData::~LampControllerData ( )
virtual

Member Function Documentation

◆ GetAnalogFeedback()

int fcf::devmgr::lamp::LampControllerData::GetAnalogFeedback ( ) const
inline

◆ GetErrorText()

std::string fcf::devmgr::lamp::LampControllerData::GetErrorText ( ) const
inline

◆ GetIntensity()

double fcf::devmgr::lamp::LampControllerData::GetIntensity ( ) const
inline

◆ GetOnAnalog()

bool fcf::devmgr::lamp::LampControllerData::GetOnAnalog ( ) const
inline

◆ GetOnDigital()

bool fcf::devmgr::lamp::LampControllerData::GetOnDigital ( ) const
inline

◆ GetSubstateStr()

virtual std::string fcf::devmgr::lamp::LampControllerData::GetSubstateStr ( ) const
inlinevirtual

◆ GetTimeLeft()

unsigned int fcf::devmgr::lamp::LampControllerData::GetTimeLeft ( ) const
inline

◆ SetAnalogFeedback()

void fcf::devmgr::lamp::LampControllerData::SetAnalogFeedback ( int  feedback)
inline

◆ SetData()

void fcf::devmgr::lamp::LampControllerData::SetData ( const LampControllerData data)

◆ SetIntensity()

void fcf::devmgr::lamp::LampControllerData::SetIntensity ( double  intensity)
inline

◆ SetOnAnalog()

void fcf::devmgr::lamp::LampControllerData::SetOnAnalog ( bool  on_analog)
inline

◆ SetOnDigital()

void fcf::devmgr::lamp::LampControllerData::SetOnDigital ( bool  on_digital)
inline

◆ SetTimeLeft()

void fcf::devmgr::lamp::LampControllerData::SetTimeLeft ( unsigned int  time_left)
inline

Member Data Documentation

◆ m_analog_feedback

int fcf::devmgr::lamp::LampControllerData::m_analog_feedback
protected

◆ m_intensity

double fcf::devmgr::lamp::LampControllerData::m_intensity
protected

◆ m_on_analog

bool fcf::devmgr::lamp::LampControllerData::m_on_analog
protected

◆ m_on_digital

bool fcf::devmgr::lamp::LampControllerData::m_on_digital
protected

◆ m_time_left

unsigned int fcf::devmgr::lamp::LampControllerData::m_time_left
protected

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