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

The drotControllerData struct. More...

#include <drotLcsIf.hpp>

Inheritance diagram for fcf::devmgr::drot::DrotControllerData:
fcf::devmgr::motor::MotorControllerData fcf::devmgr::motor::MotorBaseControllerData fcf::devmgr::common::DeviceControllerData

Public Member Functions

 DrotControllerData ()
 
virtual ~DrotControllerData ()
 
void SetData (const DrotControllerData &data)
 
virtual std::string GetErrorText () const
 
virtual std::string GetSubstateStr () const
 
short GetTrackingMode () const
 
std::string GetTrackingModeStr () const
 
void SetTrackingMode (short mode)
 
double GetRotationAngle () const
 
void SetRotationAngle (double alpha)
 
double GetPupilAngle () const
 
void SetPupilAngle (double delta)
 
double GetAngleOnSky () const
 
void SetAngleOnSky (double offset)
 
double GetTrackOffset () const
 
void SetTrackOffset (double offset)
 
- Public Member Functions inherited from fcf::devmgr::motor::MotorControllerData
 MotorControllerData ()
 
virtual ~MotorControllerData ()
 
double GetScaleFactor () const
 
void SetScaleFactor (double scale)
 
bool GetBrakeFlag () const
 
void SetBrakeFlag (bool flag)
 
bool GetEnableFlag () const
 
void SetEnableFlag (bool flag)
 
bool GetLockFlag () const
 
void SetLockFlag (bool flag)
 
int GetMode () const
 
void SetMode (int mode)
 
bool GetReadyFlag () const
 
void SetReadyFlag (bool flag)
 
bool GetInPositionFlag () const
 
void SetInPositionFlag (bool flag)
 
short GetInfoData1 () const
 
void SetInfoData1 (short info)
 
short GetInfoData2 () const
 
void SetInfoData2 (short info)
 
bool GetSignalFlag (Signal signal) const
 
void SetSignalFlag (Signal signal, bool flag)
 
void SetData (const MotorControllerData &data)
 
- Public Member Functions inherited from fcf::devmgr::motor::MotorBaseControllerData
 MotorBaseControllerData ()
 
virtual ~MotorBaseControllerData ()
 
double GetActualPos () const
 
void SetActualPos (double position)
 
double GetPosError () const
 
void SetPosError (double pos_error)
 
double GetActualVel () const
 
void SetActualVel (double velocity)
 
double GetTargetPos () const
 
void SetTargetPos (double position)
 
double GetTargetVel () const
 
void SetTargetVel (double velocity)
 
- 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 {0}
 
double m_rotation {0.0}
 
double m_pupil {0.0}
 
double m_angle_on_sky {0.0}
 
double m_track_offset {0.0}
 
- Protected Attributes inherited from fcf::devmgr::motor::MotorControllerData
double m_scale_factor {1}
 
bool m_brake {false}
 
bool m_enabled {false}
 
bool m_locked {false}
 
int m_mode {}
 
bool m_ready {false}
 
bool m_in_position {false}
 
int m_info_data1 {}
 
int m_info_data2 {}
 
std::vector< bool > m_signals
 
- Protected Attributes inherited from fcf::devmgr::motor::MotorBaseControllerData
double m_target_pos {}
 
double m_actual_pos {}
 
double m_pos_error {}
 
double m_actual_vel {}
 
double m_target_vel {}
 
double m_scale_factor {1}
 
- Protected Attributes inherited from fcf::devmgr::common::DeviceControllerData
int m_state
 
int m_substate
 
bool m_local
 
int m_error_code
 

Detailed Description

The drotControllerData struct.

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

Constructor & Destructor Documentation

◆ DrotControllerData()

fcf::devmgr::drot::DrotControllerData::DrotControllerData ( )

◆ ~DrotControllerData()

fcf::devmgr::drot::DrotControllerData::~DrotControllerData ( )
virtual

Member Function Documentation

◆ GetAngleOnSky()

double fcf::devmgr::drot::DrotControllerData::GetAngleOnSky ( ) const
inline

◆ GetErrorText()

virtual std::string fcf::devmgr::drot::DrotControllerData::GetErrorText ( ) const
inlinevirtual

◆ GetPupilAngle()

double fcf::devmgr::drot::DrotControllerData::GetPupilAngle ( ) const
inline

◆ GetRotationAngle()

double fcf::devmgr::drot::DrotControllerData::GetRotationAngle ( ) const
inline

◆ GetSubstateStr()

virtual std::string fcf::devmgr::drot::DrotControllerData::GetSubstateStr ( ) const
inlinevirtual

◆ GetTrackingMode()

short fcf::devmgr::drot::DrotControllerData::GetTrackingMode ( ) const
inline

◆ GetTrackingModeStr()

std::string fcf::devmgr::drot::DrotControllerData::GetTrackingModeStr ( ) const
inline

◆ GetTrackOffset()

double fcf::devmgr::drot::DrotControllerData::GetTrackOffset ( ) const
inline

◆ SetAngleOnSky()

void fcf::devmgr::drot::DrotControllerData::SetAngleOnSky ( double  offset)
inline

◆ SetData()

void fcf::devmgr::drot::DrotControllerData::SetData ( const DrotControllerData data)

◆ SetPupilAngle()

void fcf::devmgr::drot::DrotControllerData::SetPupilAngle ( double  delta)
inline

◆ SetRotationAngle()

void fcf::devmgr::drot::DrotControllerData::SetRotationAngle ( double  alpha)
inline

◆ SetTrackingMode()

void fcf::devmgr::drot::DrotControllerData::SetTrackingMode ( short  mode)
inline

◆ SetTrackOffset()

void fcf::devmgr::drot::DrotControllerData::SetTrackOffset ( double  offset)
inline

Member Data Documentation

◆ m_angle_on_sky

double fcf::devmgr::drot::DrotControllerData::m_angle_on_sky {0.0}
protected

◆ m_pupil

double fcf::devmgr::drot::DrotControllerData::m_pupil {0.0}
protected

◆ m_rotation

double fcf::devmgr::drot::DrotControllerData::m_rotation {0.0}
protected

◆ m_track_offset

double fcf::devmgr::drot::DrotControllerData::m_track_offset {0.0}
protected

◆ m_tracking_mode

short fcf::devmgr::drot::DrotControllerData::m_tracking_mode {0}
protected

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