fgf::andor::SetupParam Struct Reference

The State struct. More...

#include <setupParam.hpp>

Public Types
enum class	ParamEnum : short {   CTRL_TEMPERATURE_SETPOINT_CODE = 700 , CTRL_FAN_SPEED_CODE , CTRL_SENSOR_COOLING_CODE , CTRL_GAIN_MODE_CODE ,   CTRL_OVERLAP_CODE , CTRL_PIXEL_ENCODING_CODE , CTRL_PIXEL_READOUT_RATE_CODE , CTRL_ELECTRONIC_SHUTTERING_MODE_CODE ,   CTRL_TRIGGER_MODE_CODE }
using	SetupParamMap_t = boost::bimap<std::string, SetupParam::ParamEnum>

Static Public Member Functions
static std::optional< SetupParam::ParamEnum >	GetSetupParam (const std::string &param)
	Get state as an enumeration.
static std::optional< std::string >	GetSetupParamStr (const ParamEnum param)
	Get state as an optional string.

Static Public Attributes
static SetupParamMap_t	SetupParamMap

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

SetupParamMap_t

using fgf::andor::SetupParam::SetupParamMap_t = boost::bimap<std::string, SetupParam::ParamEnum>

Member Enumeration Documentation

ParamEnum

enum class fgf::andor::SetupParam::ParamEnum : short

strong

Enumerator
CTRL_TEMPERATURE_SETPOINT_CODE
CTRL_FAN_SPEED_CODE
CTRL_SENSOR_COOLING_CODE
CTRL_GAIN_MODE_CODE
CTRL_OVERLAP_CODE
CTRL_PIXEL_ENCODING_CODE
CTRL_PIXEL_READOUT_RATE_CODE
CTRL_ELECTRONIC_SHUTTERING_MODE_CODE
CTRL_TRIGGER_MODE_CODE

Member Function Documentation

GetSetupParam()

static std::optional< SetupParam::ParamEnum > fgf::andor::SetupParam::GetSetupParam ( const std::string & param )

inlinestatic

Get state as an enumeration.

Parameters

state

string containing the state

Returns

GetSetupParamStr()

static std::optional< std::string > fgf::andor::SetupParam::GetSetupParamStr ( const ParamEnum param )

inlinestatic

Get state as an optional string.

Parameters

state

enumeration of the state

Returns

Member Data Documentation

SetupParamMap

SetupParamMap_t fgf::andor::SetupParam::SetupParamMap

inlinestatic

Initial value:

= boost::assign::list_of<SetupParam::SetupParamMap_t::relation >
                (CTRL_TEMPERATURE_SETPOINT_STR,         ParamEnum::CTRL_TEMPERATURE_SETPOINT_CODE)
                (CTRL_FAN_SPEED_STR,                    ParamEnum::CTRL_FAN_SPEED_CODE)
                (CTRL_SENSOR_COOLING_STR,               ParamEnum::CTRL_SENSOR_COOLING_CODE)
                (CTRL_GAIN_MODE_STR,                    ParamEnum::CTRL_GAIN_MODE_CODE)
                (CTRL_OVERLAP_STR,                      ParamEnum::CTRL_OVERLAP_CODE)
                (CTRL_PIXEL_ENCODING_STR,               ParamEnum::CTRL_PIXEL_ENCODING_CODE)
                (CTRL_PIXEL_READOUT_RATE_STR,           ParamEnum::CTRL_PIXEL_READOUT_RATE_CODE)
                (CTRL_ELECTRONIC_SHUTTERING_MODE_STR,   ParamEnum::CTRL_ELECTRONIC_SHUTTERING_MODE_CODE)
                (CTRL_TRIGGER_MODE_STR,                 ParamEnum::CTRL_TRIGGER_MODE_CODE)

---

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

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