Struct SParamInfo

• Defined in File param.h

Nested Relationships

Nested Types

• Union SParamInfo::eType

• Union SParamInfo::union_0

Inheritance Relationships

Derived Type

• private sdv::CSdvParamInfo (Class CSdvParamInfo)

Struct Documentation

struct SParamInfo

Structure to represent parameter information.

Subclassed by sdv::CSdvParamInfo

Public Functions

inline SParamInfo()

Constructor

inline SParamInfo(const SParamInfo &rvar)

Copy constructor

Parameters:

rvar – [in] Reference to the SParamInfo variable to copy from.

inline SParamInfo(SParamInfo &&rvar) noexcept

Move constructor

Parameters:

rvar – [in] Reference to the SParamInfo variable to move from.

inline ~SParamInfo()

Destructor

inline SParamInfo &operator=(const SParamInfo &rvar)

Assignment operator

Parameters:

rvar – [in] Reference to the SParamInfo variable to copy from.

Returns:

Returns a reference to this entity.

inline SParamInfo &operator=(SParamInfo &&rvar) noexcept

Move operator

Parameters:

rvar – [in] Reference to the SParamInfo variable to move from.

Returns:

Returns a reference to this entity.

inline void switch_to(sdv::EParamType val)

Set the switch type for the union union_0

Parameters:

val – [in] Value of the switch variable to select the switch type.

inline sdv::EParamType get_switch() const

Get the switch value

Returns:

Returns the current switch value.

Public Members

uint32_t uiFlags

Parameter flags containing one or more values of the EParamFlags enumeration.

sdv::u8string ssName

The name of the parameter.

sdv::u8string ssGroup

Optional group name for this parameter. Can contain sub-groups separated by a dot.

sdv::u8string ssUnit

Optional parameter unit.

sdv::u8string ssDescription

Optional parameter description.

sdv::any_t anyDefaultVal

Default value.

union sdv::SParamInfo::union_0 uExtInfo

uint32 uiFlags

Parameter flags containing one or more values of the EParamFlags enumeration.

u8string ssName

The name of the parameter.

u8string ssGroup

Optional group name for this parameter. Can contain sub-groups separated by a dot.

u8string ssUnit

Optional parameter unit.

u8string ssDescription

Optional parameter description.

any anyDefaultVal

Default value.

union sdv::SParamInfo::eType uExtInfo

Extended parameter information.

union eType

Union holding extended parameter information.

Public Members

SNumberInfo sNumberInfo

Additional information for number types.

SStringInfo sStringInfo

Additional information for string types.

SLabelInfo sEnumInfo

Additional information for enumeration types.

SLabelInfo sBitmaskInfo

Additional information for bitmask types.

union union_0

Extended parameter information.

Union holding extended parameter information.

Public Functions

inline union_0()

Constructor

inline ~union_0()

Destructor

Public Members

SNumberInfo sNumberInfo

Additional information for number types.

SStringInfo sStringInfo

Additional information for string types.

SLabelInfo sEnumInfo

Additional information for enumeration types.

SLabelInfo sBitmaskInfo

Additional information for bitmask types.