ifw::fgf::common::SetupParam Struct Reference

Setup ("ctrl" category) parameters enums. More...

#include <setupParam.hpp>

Public Types
enum class	ParamEnum : short {   CTRL_EXPO_TIME_CODE = 100 , CTRL_FRAME_RATE_CODE = 110 , CTRL_BIN_X_CODE = 120 , CTRL_BIN_Y_CODE = 130 ,   CTRL_FRAME_TARGET_CODE = 140 , CTRL_OP_MODE_CODE = 150 , CTRL_OFFSET_X_CODE = 160 , CTRL_OFFSET_Y_CODE = 170 ,   CTRL_WIDTH_CODE = 180 , CTRL_HEIGHT_CODE = 190 , CTRL_EXPO_TIME_CODE = 100 , CTRL_FRAME_RATE_CODE = 110 ,   CTRL_BIN_X_CODE = 120 , CTRL_BIN_Y_CODE = 130 , CTRL_FRAME_TARGET_CODE = 140 , CTRL_OP_MODE_CODE = 150 ,   CTRL_OFFSET_X_CODE = 160 , CTRL_OFFSET_Y_CODE = 170 , CTRL_WIDTH_CODE = 180 , CTRL_HEIGHT_CODE = 190 }
enum class	ParamEnum : short {   CTRL_EXPO_TIME_CODE = 100 , CTRL_FRAME_RATE_CODE = 110 , CTRL_BIN_X_CODE = 120 , CTRL_BIN_Y_CODE = 130 ,   CTRL_FRAME_TARGET_CODE = 140 , CTRL_OP_MODE_CODE = 150 , CTRL_OFFSET_X_CODE = 160 , CTRL_OFFSET_Y_CODE = 170 ,   CTRL_WIDTH_CODE = 180 , CTRL_HEIGHT_CODE = 190 , CTRL_EXPO_TIME_CODE = 100 , CTRL_FRAME_RATE_CODE = 110 ,   CTRL_BIN_X_CODE = 120 , CTRL_BIN_Y_CODE = 130 , CTRL_FRAME_TARGET_CODE = 140 , CTRL_OP_MODE_CODE = 150 ,   CTRL_OFFSET_X_CODE = 160 , CTRL_OFFSET_Y_CODE = 170 , CTRL_WIDTH_CODE = 180 , CTRL_HEIGHT_CODE = 190 }
using	SetupParamMap_t = boost::bimap<std::string, SetupParam::ParamEnum>
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 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

Setup ("ctrl" category) parameters enums.

Member Typedef Documentation

SetupParamMap_t [1/2]

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

SetupParamMap_t [2/2]

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

Member Enumeration Documentation

ParamEnum [1/2]

enum class ifw::fgf::common::SetupParam::ParamEnum : short

strong

Enumerator
CTRL_EXPO_TIME_CODE
CTRL_FRAME_RATE_CODE
CTRL_BIN_X_CODE
CTRL_BIN_Y_CODE
CTRL_FRAME_TARGET_CODE
CTRL_OP_MODE_CODE
CTRL_OFFSET_X_CODE
CTRL_OFFSET_Y_CODE
CTRL_WIDTH_CODE
CTRL_HEIGHT_CODE
CTRL_EXPO_TIME_CODE
CTRL_FRAME_RATE_CODE
CTRL_BIN_X_CODE
CTRL_BIN_Y_CODE
CTRL_FRAME_TARGET_CODE
CTRL_OP_MODE_CODE
CTRL_OFFSET_X_CODE
CTRL_OFFSET_Y_CODE
CTRL_WIDTH_CODE
CTRL_HEIGHT_CODE

ParamEnum [2/2]

enum class ifw::fgf::common::SetupParam::ParamEnum : short

strong

Enumerator
CTRL_EXPO_TIME_CODE
CTRL_FRAME_RATE_CODE
CTRL_BIN_X_CODE
CTRL_BIN_Y_CODE
CTRL_FRAME_TARGET_CODE
CTRL_OP_MODE_CODE
CTRL_OFFSET_X_CODE
CTRL_OFFSET_Y_CODE
CTRL_WIDTH_CODE
CTRL_HEIGHT_CODE
CTRL_EXPO_TIME_CODE
CTRL_FRAME_RATE_CODE
CTRL_BIN_X_CODE
CTRL_BIN_Y_CODE
CTRL_FRAME_TARGET_CODE
CTRL_OP_MODE_CODE
CTRL_OFFSET_X_CODE
CTRL_OFFSET_Y_CODE
CTRL_WIDTH_CODE
CTRL_HEIGHT_CODE

Member Function Documentation

GetSetupParam() [1/2]

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

inlinestatic

Get state as an enumeration.

GetSetupParam() [2/2]

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

inlinestatic

Get state as an enumeration.

GetSetupParamStr() [1/2]

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

inlinestatic

Get state as an optional string.

GetSetupParamStr() [2/2]

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

inlinestatic

Get state as an optional string.

Member Data Documentation

SetupParamMap

static SetupParamMap_t ifw::fgf::common::SetupParam::SetupParamMap

inlinestatic

Initial value:

= boost::assign::list_of<SetupParam::SetupParamMap_t::relation >
                (CTRL_EXPO_TIME_STR,        ParamEnum::CTRL_EXPO_TIME_CODE)
                (CTRL_FRAME_RATE_STR,       ParamEnum::CTRL_FRAME_RATE_CODE)
                (CTRL_BIN_X_STR,            ParamEnum::CTRL_BIN_X_CODE)
                (CTRL_BIN_Y_STR,            ParamEnum::CTRL_BIN_Y_CODE)
                (CTRL_FRAME_TARGET_STR,     ParamEnum::CTRL_FRAME_TARGET_CODE)
                (CTRL_OP_MODE_STR,          ParamEnum::CTRL_OP_MODE_CODE)
                (CTRL_OFFSET_X_STR,         ParamEnum::CTRL_OFFSET_X_CODE)
                (CTRL_OFFSET_Y_STR,         ParamEnum::CTRL_OFFSET_Y_CODE)
                (CTRL_WIDTH_STR,            ParamEnum::CTRL_WIDTH_CODE)
                (CTRL_HEIGHT_STR,           ParamEnum::CTRL_HEIGHT_CODE)

---

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

• fgf/common/src/include/ifw/fgf/common/setupParam.hpp
• fgf/common_llnetio/src/include/ifw/fgf/common_llnetio/setupParam.hpp