fgf::andor::StatusParam Struct Reference

The State struct. More...

#include <statusParam.hpp>

Public Types
enum class	StatusEnum : short {   STAT_STRIDE_CODE = 500 , STAT_OVERLAP_CODE , STAT_SENSOR_COOLING_CODE , STAT_SENSOR_TEMPERATURE_CODE ,   STAT_TEMPERATURE_CTRL_CODE , STAT_TEMPERATURE_STAT_CODE , STAT_PIXEL_ENCODING_CODE , STAT_PIXEL_READOUT_RATE_CODE ,   STAT_PRE_AMP_GAIN_CTRL_CODE , STAT_SIMPLE_PRE_AMP_GAIN_CTRL_CODE , STAT_CAMERA_STATUS_CODE , STAT_BIT_DEPTH_CODE ,   STAT_ELECTRONIC_SHUTTERING_MODE_CODE , STAT_CMD_ERROR_TEXT_CODE , STAT_FAN_SPEED_CODE , STAT_METADATA_ENABLE_CODE ,   STAT_TRIGGER_MODE_CODE }
using	StatusParamMap_t = boost::bimap<std::string, StatusParam::StatusEnum>

Static Public Member Functions
static std::optional< StatusParam::StatusEnum >	GetStatusParam (const std::string &param)
	Get state as an enumeration.
static std::optional< std::string >	GetStatusParamStr (const StatusEnum param)
	Get state as an optional string.

Static Public Attributes
static StatusParamMap_t	StatusParamMap

Detailed Description

The State struct.

This structure is used store the basic state information. It has a bidirectional maps used by classes to get the name or enumeration associated to a parameter. Methods are static so they can be used without an object.

Member Typedef Documentation

StatusParamMap_t

using fgf::andor::StatusParam::StatusParamMap_t = boost::bimap<std::string, StatusParam::StatusEnum>

Member Enumeration Documentation

StatusEnum

enum class fgf::andor::StatusParam::StatusEnum : short

strong

Enumerator
STAT_STRIDE_CODE
STAT_OVERLAP_CODE
STAT_SENSOR_COOLING_CODE
STAT_SENSOR_TEMPERATURE_CODE
STAT_TEMPERATURE_CTRL_CODE
STAT_TEMPERATURE_STAT_CODE
STAT_PIXEL_ENCODING_CODE
STAT_PIXEL_READOUT_RATE_CODE
STAT_PRE_AMP_GAIN_CTRL_CODE
STAT_SIMPLE_PRE_AMP_GAIN_CTRL_CODE
STAT_CAMERA_STATUS_CODE
STAT_BIT_DEPTH_CODE
STAT_ELECTRONIC_SHUTTERING_MODE_CODE
STAT_CMD_ERROR_TEXT_CODE
STAT_FAN_SPEED_CODE
STAT_METADATA_ENABLE_CODE
STAT_TRIGGER_MODE_CODE

Member Function Documentation

GetStatusParam()

static std::optional< StatusParam::StatusEnum > fgf::andor::StatusParam::GetStatusParam ( const std::string & param )

inlinestatic

Get state as an enumeration.

Parameters

state

string containing the state

Returns

GetStatusParamStr()

static std::optional< std::string > fgf::andor::StatusParam::GetStatusParamStr ( const StatusEnum param )

inlinestatic

Get state as an optional string.

Parameters

state

enumeration of the state

Returns

Member Data Documentation

StatusParamMap

StatusParamMap_t fgf::andor::StatusParam::StatusParamMap

inlinestatic

Initial value:

=
            boost::assign::list_of<StatusParam::StatusParamMap_t::relation>
                
                (STAT_STRIDE_STR,                       StatusEnum::STAT_STRIDE_CODE)
                (STAT_OVERLAP_STR,                      StatusEnum::STAT_OVERLAP_CODE)
                (STAT_SENSOR_COOLING_STR,               StatusEnum::STAT_SENSOR_COOLING_CODE)
                (STAT_SENSOR_TEMPERATURE_STR,           StatusEnum::STAT_SENSOR_TEMPERATURE_CODE)
                (STAT_TEMPERATURE_CTRL_STR,             StatusEnum::STAT_TEMPERATURE_CTRL_CODE)
                (STAT_TEMPERATURE_STAT_STR,             StatusEnum::STAT_TEMPERATURE_STAT_CODE)
                (STAT_PIXEL_ENCODING_STR,               StatusEnum::STAT_PIXEL_ENCODING_CODE)
                (STAT_PIXEL_READOUT_RATE_STR,           StatusEnum::STAT_PIXEL_READOUT_RATE_CODE)
                (STAT_PRE_AMP_GAIN_CTRL_STR,            StatusEnum::STAT_PRE_AMP_GAIN_CTRL_CODE)
                (STAT_SIMPLE_PRE_AMP_GAIN_CTRL_STR,     StatusEnum::STAT_SIMPLE_PRE_AMP_GAIN_CTRL_CODE)
                (STAT_CAMERA_STATUS_STR,                StatusEnum::STAT_CAMERA_STATUS_CODE)
                (STAT_BIT_DEPTH_STR,                    StatusEnum::STAT_BIT_DEPTH_CODE)
                (STAT_ELECTRONIC_SHUTTERING_MODE_STR,   StatusEnum::STAT_ELECTRONIC_SHUTTERING_MODE_CODE)
                (STAT_CMD_ERROR_TEXT_STR,               StatusEnum::STAT_CMD_ERROR_TEXT_CODE)
                (STAT_FAN_SPEED_STR,                    StatusEnum::STAT_FAN_SPEED_CODE)
                (STAT_METADATA_ENABLE_STR,              StatusEnum::STAT_METADATA_ENABLE_CODE)
                (STAT_TRIGGER_MODE_STR,                 StatusEnum::STAT_TRIGGER_MODE_CODE)

---

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

• cameras/fgf-andor/adapter/src/include/fgf/andor/statusParam.hpp