Boardcore::EntryStructsUnion Struct Reference

Union data struct to be stored in the map. It does contain the enumeration index and the value of such configuration entry. More...

#include <RegistryTypes.h>

Public Member Functions
	EntryStructsUnion ()=default
	Default constructor to construct a new Entry Structs Union object.
size_t	sizeBytes ()
	Returns the size in byte of the type + value.
bool	get (float &outValue)
	Gets from the TypeUnion the float value and returns it.
bool	get (uint32_t &outValue)
	Get from Union object the unsigned integer 32b value.
bool	get (Coordinates &outValue)
	Get from Union object the coordinates value.
TypeUnion	getValue ()
	Get the Value object.
TypesEnum	getType ()
	Get the Type object.

Static Public Member Functions
static EntryStructsUnion	make (float value)
	Set the Union object with its float value.
static EntryStructsUnion	make (uint32_t value)
	Set the Union object with its unsigned 32bit integer value.
static EntryStructsUnion	make (Coordinates value)
	Set the Union object with its Coordinates value.

Detailed Description

Union data struct to be stored in the map. It does contain the enumeration index and the value of such configuration entry.

Definition at line 88 of file RegistryTypes.h.

Constructor & Destructor Documentation

EntryStructsUnion()

Boardcore::EntryStructsUnion::EntryStructsUnion ( )

default

Default constructor to construct a new Entry Structs Union object.

Member Function Documentation

get() [1/3]

bool Boardcore::EntryStructsUnion::get ( Coordinates & outValue )

inline

Get from Union object the coordinates value.

Parameters

outValue

the coordinates value saved into the union type

Returns

True if the data type is correct w.r.t. the saved one

Definition at line 155 of file RegistryTypes.h.

get() [2/3]

bool Boardcore::EntryStructsUnion::get ( float & outValue )

inline

Gets from the TypeUnion the float value and returns it.

Parameters

outValue

the float value saved into the union type

Returns

True if the data type is correct w.r.t. the saved one

Definition at line 127 of file RegistryTypes.h.

get() [3/3]

bool Boardcore::EntryStructsUnion::get ( uint32_t & outValue )

inline

Get from Union object the unsigned integer 32b value.

Parameters

outValue

the uint32_t value saved into the union type

Returns

True if the data type is correct w.r.t. the saved one

Definition at line 141 of file RegistryTypes.h.

getType()

TypesEnum Boardcore::EntryStructsUnion::getType ( )

inline

Get the Type object.

Returns

TypeUnion the type of this entry

Definition at line 214 of file RegistryTypes.h.

getValue()

TypeUnion Boardcore::EntryStructsUnion::getValue ( )

inline

Get the Value object.

Returns

TypeUnion the type of this entry

Definition at line 207 of file RegistryTypes.h.

make() [1/3]

static EntryStructsUnion Boardcore::EntryStructsUnion::make ( Coordinates value )

inlinestatic

Set the Union object with its Coordinates value.

Parameters

value

The value to be set into the union type

Returns

The created EntryStructUnion instance for such value and type

Definition at line 195 of file RegistryTypes.h.

make() [2/3]

static EntryStructsUnion Boardcore::EntryStructsUnion::make ( float value )

inlinestatic

Set the Union object with its float value.

Parameters

value

The value to be set into the union type

Returns

The created EntryStructUnion instance for such value and type

Definition at line 169 of file RegistryTypes.h.

make() [3/3]

static EntryStructsUnion Boardcore::EntryStructsUnion::make ( uint32_t value )

inlinestatic

Set the Union object with its unsigned 32bit integer value.

Parameters

value

The value to be set into the union type

Returns

The created EntryStructUnion instance for such value and type

Definition at line 182 of file RegistryTypes.h.

sizeBytes()

size_t Boardcore::EntryStructsUnion::sizeBytes ( )

inline

Returns the size in byte of the type + value.

Returns

size_t The type + value size in Bytes

Definition at line 100 of file RegistryTypes.h.

---

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

• src/shared/utils/Registry/RegistryTypes.h