ifw::fgf::common::StatusParam Struct Reference

The status parameters enums definitions. More...

#include <statusParam.hpp>

Public Types
enum class	StatusEnum : short {   STAT_FRAME_RATE_CODE = 300 , STAT_EXPO_TIME_CODE = 305 , STAT_FRAME_COUNTER_CODE = 310 , STAT_TOTAL_FRAME_COUNTER_CODE = 320 ,   STAT_WIDTH_CODE = 330 , STAT_HEIGHT_CODE = 340 , STAT_CAMERA_INTERFACE_CODE = 350 , STAT_CAMERA_MODEL_CODE = 360 ,   STAT_CAMERA_NAME_CODE = 370 , STAT_CAMERA_SERIAL_NUMBER_CODE = 380 , STAT_STATE_CODE = 390 , STAT_SUBSTATE_CODE = 400 ,   STAT_RPC_ERROR_TEXT_CODE = 410 , STAT_SYSTEM_ERROR_TEXT_CODE = 420 }
	Status ("stat" category) parameters enums. More...
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 status parameters enums definitions.

Member Typedef Documentation

StatusParamMap_t

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

Member Enumeration Documentation

StatusEnum

enum class ifw::fgf::common::StatusParam::StatusEnum : short

strong

Status ("stat" category) parameters enums.

Enumerator
STAT_FRAME_RATE_CODE
STAT_EXPO_TIME_CODE
STAT_FRAME_COUNTER_CODE
STAT_TOTAL_FRAME_COUNTER_CODE
STAT_WIDTH_CODE
STAT_HEIGHT_CODE
STAT_CAMERA_INTERFACE_CODE
STAT_CAMERA_MODEL_CODE
STAT_CAMERA_NAME_CODE
STAT_CAMERA_SERIAL_NUMBER_CODE
STAT_STATE_CODE
STAT_SUBSTATE_CODE
STAT_RPC_ERROR_TEXT_CODE
STAT_SYSTEM_ERROR_TEXT_CODE

Member Function Documentation

GetStatusParam()

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

inlinestatic

Get state as an enumeration.

GetStatusParamStr()

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

inlinestatic

Get state as an optional string.

Member Data Documentation

StatusParamMap

StatusParamMap_t ifw::fgf::common::StatusParam::StatusParamMap

inlinestatic

Initial value:

=
            boost::assign::list_of<StatusParam::StatusParamMap_t::relation>
                (STAT_FRAME_RATE_STR,            StatusEnum::STAT_FRAME_RATE_CODE)
                (STAT_EXPO_TIME_STR,             StatusEnum::STAT_EXPO_TIME_CODE)
                (STAT_FRAME_COUNTER_STR,         StatusEnum::STAT_FRAME_COUNTER_CODE)
                (STAT_TOTAL_FRAME_COUNTER_STR,   StatusEnum::STAT_TOTAL_FRAME_COUNTER_CODE)
                (STAT_WIDTH_STR,                 StatusEnum::STAT_WIDTH_CODE)
                (STAT_HEIGHT_STR,                StatusEnum::STAT_HEIGHT_CODE)
                (STAT_CAMERA_INTERFACE_STR,      StatusEnum::STAT_CAMERA_INTERFACE_CODE)
                (STAT_CAMERA_MODEL_STR,          StatusEnum::STAT_CAMERA_MODEL_CODE)
                (STAT_CAMERA_NAME_STR,           StatusEnum::STAT_CAMERA_NAME_CODE)
                (STAT_CAMERA_SERIAL_NUMBER_STR,  StatusEnum::STAT_CAMERA_SERIAL_NUMBER_CODE)
                (STAT_STATE_STR,                 StatusEnum::STAT_STATE_CODE)
                (STAT_SUBSTATE_STR,              StatusEnum::STAT_SUBSTATE_CODE)
                (STAT_RPC_ERROR_TEXT_STR,        StatusEnum::STAT_RPC_ERROR_TEXT_CODE)
                (STAT_SYSTEM_ERROR_TEXT_STR,     StatusEnum::STAT_SYSTEM_ERROR_TEXT_CODE)

---

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

• fgf/common/src/include/ifw/fgf/common/statusParam.hpp