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

The adcControllerData struct. More...

#include <adcLcsIf.hpp>

Inheritance diagram for fcf::devmgr::adc::AdcControllerData:
fcf::devmgr::common::DeviceControllerData

Public Member Functions

 AdcControllerData ()
 
virtual ~AdcControllerData ()
 
void SetData (const AdcControllerData &data)
 
virtual std::string GetErrorText () const
 
virtual std::string GetSubstateStr () const
 
short GetTrackingMode () const
 
std::string GetTrackingModeStr () const
 
void SetTrackingMode (short mode)
 
double GetAlpha () const
 
void SetAlpha (double alpha)
 
double GetDelta () const
 
void SetDelta (double delta)
 
fcf::devmgr::motor::MotorControllerData GetMotor (std::string motor) const
 
void ClearMotors ()
 
void AddMotor (const std::string motor, const fcf::devmgr::motor::MotorControllerData motor_data)
 
void GetMotorNames (std::vector< std::string > &motor_vector)
 
- 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

short m_tracking_mode {}
 
double m_alpha {}
 
double m_delta {}
 
std::map< std::string, fcf::devmgr::motor::MotorControllerDatam_motors
 
- Protected Attributes inherited from fcf::devmgr::common::DeviceControllerData
int m_state
 
int m_substate
 
bool m_local
 
int m_error_code
 

Detailed Description

The adcControllerData struct.

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

Constructor & Destructor Documentation

◆ AdcControllerData()

fcf::devmgr::adc::AdcControllerData::AdcControllerData ( )

◆ ~AdcControllerData()

fcf::devmgr::adc::AdcControllerData::~AdcControllerData ( )
virtual

Member Function Documentation

◆ AddMotor()

void fcf::devmgr::adc::AdcControllerData::AddMotor ( const std::string  motor,
const fcf::devmgr::motor::MotorControllerData  motor_data 
)
inline

◆ ClearMotors()

void fcf::devmgr::adc::AdcControllerData::ClearMotors ( )
inline

◆ GetAlpha()

double fcf::devmgr::adc::AdcControllerData::GetAlpha ( ) const
inline

◆ GetDelta()

double fcf::devmgr::adc::AdcControllerData::GetDelta ( ) const
inline

◆ GetErrorText()

virtual std::string fcf::devmgr::adc::AdcControllerData::GetErrorText ( ) const
inlinevirtual

◆ GetMotor()

fcf::devmgr::motor::MotorControllerData fcf::devmgr::adc::AdcControllerData::GetMotor ( std::string  motor) const
inline

◆ GetMotorNames()

void fcf::devmgr::adc::AdcControllerData::GetMotorNames ( std::vector< std::string > &  motor_vector)
inline

◆ GetSubstateStr()

virtual std::string fcf::devmgr::adc::AdcControllerData::GetSubstateStr ( ) const
inlinevirtual

◆ GetTrackingMode()

short fcf::devmgr::adc::AdcControllerData::GetTrackingMode ( ) const
inline

◆ GetTrackingModeStr()

std::string fcf::devmgr::adc::AdcControllerData::GetTrackingModeStr ( ) const
inline

◆ SetAlpha()

void fcf::devmgr::adc::AdcControllerData::SetAlpha ( double  alpha)
inline

◆ SetData()

void fcf::devmgr::adc::AdcControllerData::SetData ( const AdcControllerData data)

◆ SetDelta()

void fcf::devmgr::adc::AdcControllerData::SetDelta ( double  delta)
inline

◆ SetTrackingMode()

void fcf::devmgr::adc::AdcControllerData::SetTrackingMode ( short  mode)
inline

Member Data Documentation

◆ m_alpha

double fcf::devmgr::adc::AdcControllerData::m_alpha {}
protected

◆ m_delta

double fcf::devmgr::adc::AdcControllerData::m_delta {}
protected

◆ m_motors

std::map<std::string, fcf::devmgr::motor::MotorControllerData> fcf::devmgr::adc::AdcControllerData::m_motors
protected

◆ m_tracking_mode

short fcf::devmgr::adc::AdcControllerData::m_tracking_mode {}
protected

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