#include "comms/field/Bundle.h"

Detailed Description

template<typename TFieldBase, typename TEnum, typename... TOptions>
class comms::field::EnumValue< TFieldBase, TEnum, TOptions >

Enumerator value field.

Sometimes dealing with enum values is much more convenient that using integral values. comms::field::EnumValue is very similar to comms::field::IntValue, but receives underlying enum type in its template parameters instead of integral one.

Template Parameters

TFieldBase	Base class for this field, expected to be a variant of comms::Field.
TEnum	Enderlying enum type, can be either unscoped or scoped (enum class).
TOptions	Zero or more options that modify/refine default behaviour of the field. If no option is provided, the field's value is serialised as is, where the length of the field is equal to the length of the underlying enum type. For example: enum class MyEnum : std::uint16_t { Value1, Value2, Value3 } using MyFieldBase = comms::Field<comms::option::def::BigEndian>; using MyField =comms::field::EnumValue<MyFieldBase, MyEnum>; comms::Field Base class to all the field classes. Definition Field.h:33 comms::field::EnumValue Enumerator value field. Definition EnumValue.h:75 The serialised value of the field in the example above will consume 2 bytes, because the underlying type of MyEnum is defined to be std::uint16_t. The value is serialised using big endian notation because base field class receives comms::option::def::BigEndian option. Supported options are: comms::option::def::AvailableLengthLimit comms::option::def::DefaultValueInitialiser or comms::option::def::DefaultNumValue. comms::option::def::EmptySerialization comms::option::def::FailOnInvalid comms::option::def::FieldType comms::option::def::FixedBitLength comms::option::def::FixedLength comms::option::def::FixedValue comms::option::def::HasCustomRead comms::option::def::HasCustomRefresh comms::option::def::HasName comms::option::def::IgnoreInvalid comms::option::def::InvalidByDefault comms::option::def::NumValueSerOffset comms::option::def::ValidNumValueRange, comms::option::def::ValidNumValue, comms::option::def::ValidBigUnsignedNumValueRange, comms::option::def::ValidBigUnsignedNumValue comms::option::def::ValidRangesClear comms::option::def::VarLength comms::option::def::VersionStorage

Inheritance diagram for comms::field::EnumValue< TFieldBase, TEnum, TOptions >:

Public Types
using	CommsTag = typename BaseImpl::CommsTag
	Tag indicating type of the field.

using	Endian = typename BaseImpl::Endian
	Endian used for serialisation.

using	FieldBase = TFieldBase
	Base class provided in the first template parameter.

using	FieldType = typename ParsedOptions::FieldType
	Type of actual extending field specified via comms::option::def::FieldType.

using	ParsedOptions = details::OptionsParser< TOptions... >
	All the options provided to this class bundled into struct.

using	ValueType = typename BaseImpl::ValueType
	Type of underlying enum value.

using	VersionType = typename BaseImpl::VersionType
	Version type.

Public Member Functions
	EnumValue ()=default
	Default constructor.

	EnumValue (const EnumValue &)=default
	Copy constructor.

	EnumValue (const ValueType &val)
	Constructor.

	~EnumValue () noexcept=default
	Destructor.

bool	canWrite () const
	Check of whether the field has a consistent value for writing.

int	getForcedLength () const
	Get forced serialization length.

const ValueType &	getValue () const
	Get value.

VersionType	getVersion () const
	Get version of the field.

constexpr std::size_t	length () const
	Get length required to serialise the current field value.

EnumValue &	operator= (const EnumValue &)=default
	Copy assignment.

template<typename TIter >
ErrorStatus	read (TIter &iter, std::size_t size)
	Read field value from input data sequence.

template<typename TIter >
void	readNoStatus (TIter &iter)
	Read field value from input data sequence without error check and status report.

bool	refresh ()
	Refresh the field's value.

void	setForcedLength (int len)
	Force serialization length of the field.

template<typename U >
void	setValue (U &&val)
	Set value.

bool	setVersion (VersionType version)
	Default implementation of version update.

bool	valid () const
	Check validity of the field value.

ValueType &	value ()
	Get access to enum value storage.

const ValueType &	value () const
	Get access to enum value storage.

template<typename TIter >
ErrorStatus	write (TIter &iter, std::size_t size) const
	Write current field value to output data sequence.

template<typename TIter >
void	writeNoStatus (TIter &iter) const
	Write current field value to output data sequence without error check and status report.

Static Public Member Functions
static constexpr bool	canWrite ()
	Default check of whether the field has a consistent value for writing.

static constexpr bool	hasEmptySerialization ()
	Compile time inquiry of whether comms::option::def::EmptySerialization option has been used.

static constexpr bool	hasFailOnInvalid ()
	Compile time inquiry of whether comms::option::def::FailOnInvalid option has been used.

static constexpr bool	hasFieldType ()
	Compile time inquiry of whether comms::option::def::FieldType option has been used.

static constexpr bool	hasFixedValue ()
	Compile time inquiry of whether comms::option::def::FixedValue option has been used.

static constexpr bool	hasIgnoreInvalid ()
	Compile time inquiry of whether comms::option::def::IgnoreInvalid option has been used.

static constexpr bool	hasName ()
	Compile time inquiry of whether comms::option::def::HasName option has been used.

static constexpr bool	hasNonDefaultRefresh ()
	Compile time check if this class has non-default refresh functionality.

static constexpr bool	hasReadNoStatus ()
	Compile time check of whether the field has proper readNoStatus() member function.

static constexpr bool	hasVarLength ()
	Default check of whether the field has variable length definition via comms::option::def::VarLength option.

static constexpr bool	hasWriteNoStatus ()
	Compile time check of whether the field has proper writeNoStatus() member function.

static constexpr bool	isVersionDependent ()
	Compile time check if this class is version dependent.

static constexpr std::size_t	maxLength ()
	Get maximal length that is required to serialise field of this type.

static constexpr std::size_t	minLength ()
	Get minimal length that is required to serialise field of this type.

static constexpr bool	valid ()
	Default validity check.

Static Protected Member Functions
template<typename T , typename TIter >
static T	readData (TIter &iter)
	Read data from input buffer.

template<typename T , std::size_t TSize, typename TIter >
static T	readData (TIter &iter)
	Read partial data from input buffer.

template<typename T , typename TIter >
static void	writeData (T value, TIter &iter)
	Write data into the output buffer.

template<std::size_t TSize, typename T , typename TIter >
static void	writeData (T value, TIter &iter)
	Write partial data into the output buffer.

Related Symbols
(Note that these are not member symbols.)
template<typename T >
constexpr bool	isEnumValue ()
	Compile time check function of whether a provided type is any variant of comms::field::EnumValue.

template<typename TFieldBase , typename TEnum , typename... TOptions>
bool	operator!= (const EnumValue< TFieldBase, TEnum, TOptions... > &field1, const EnumValue< TFieldBase, TEnum, TOptions... > &field2) noexcept
	Non-equality comparison operator.

template<typename TFieldBase , typename TEnum , typename... TOptions>
bool	operator< (const EnumValue< TFieldBase, TEnum, TOptions... > &field1, const EnumValue< TFieldBase, TEnum, TOptions... > &field2) noexcept
	Equivalence comparison operator.

template<typename TFieldBase , typename TEnum , typename... TOptions>
bool	operator== (const EnumValue< TFieldBase, TEnum, TOptions... > &field1, const EnumValue< TFieldBase, TEnum, TOptions... > &field2) noexcept
	Equality comparison operator.

template<typename TFieldBase , typename TEnum , typename... TOptions>
const EnumValue< TFieldBase, TEnum, TOptions... > &	toFieldBase (const EnumValue< TFieldBase, TEnum, TOptions... > &field)
	Upcast type of the field definition to its parent comms::field::EnumValue type in order to have access to its internal types.

template<typename TFieldBase , typename TEnum , typename... TOptions>
EnumValue< TFieldBase, TEnum, TOptions... > &	toFieldBase (EnumValue< TFieldBase, TEnum, TOptions... > &field)
	Upcast type of the field definition to its parent comms::field::EnumValue type in order to have access to its internal types.

Member Typedef Documentation

◆ FieldType

template<typename TFieldBase , typename TEnum , typename... TOptions>

using comms::field::EnumValue< TFieldBase, TEnum, TOptions >::FieldType = typename ParsedOptions::FieldType

Type of actual extending field specified via comms::option::def::FieldType.

void if comms::option::def::FieldType hasn't been applied.

◆ ValueType

template<typename TFieldBase , typename TEnum , typename... TOptions>

using comms::field::EnumValue< TFieldBase, TEnum, TOptions >::ValueType = typename BaseImpl::ValueType

Type of underlying enum value.

Same as template parameter TEnum to this class.

Member Function Documentation

◆ canWrite()

template<typename... TOptions>

static constexpr bool comms::Field< TOptions >::canWrite ( )

staticconstexprinherited

Default check of whether the field has a consistent value for writing.

Returns: Always true.

◆ getForcedLength()

template<typename TFieldBase , typename TEnum , typename... TOptions>

int comms::field::EnumValue< TFieldBase, TEnum, TOptions >::getForcedLength ( ) const

Get forced serialization length.

See also: setForcedLength()

◆ getValue()

template<typename TFieldBase , typename TEnum , typename... TOptions>

const ValueType & comms::field::EnumValue< TFieldBase, TEnum, TOptions >::getValue ( ) const

Get value.

Implemented by calling value(), but can be overriden in the derived class

◆ getVersion()

template<typename TFieldBase , typename TEnum , typename... TOptions>

VersionType comms::field::EnumValue< TFieldBase, TEnum, TOptions >::getVersion ( ) const

Get version of the field.

Exists only if comms::option::def::VersionStorage option has been provided.

◆ hasVarLength()

template<typename... TOptions>

static constexpr bool comms::Field< TOptions >::hasVarLength ( )

staticconstexprinherited

Default check of whether the field has variable length definition via comms::option::def::VarLength option.

Returns: Always false.

◆ length()

template<typename TFieldBase , typename TEnum , typename... TOptions>

constexpr std::size_t comms::field::EnumValue< TFieldBase, TEnum, TOptions >::length ( ) const

constexpr

Get length required to serialise the current field value.

Returns: Number of bytes it will take to serialise the field value.

◆ maxLength()

template<typename TFieldBase , typename TEnum , typename... TOptions>

static constexpr std::size_t comms::field::EnumValue< TFieldBase, TEnum, TOptions >::maxLength ( )

staticconstexpr

Get maximal length that is required to serialise field of this type.

Returns: Maximal number of bytes required serialise the field value.

◆ minLength()

template<typename TFieldBase , typename TEnum , typename... TOptions>

static constexpr std::size_t comms::field::EnumValue< TFieldBase, TEnum, TOptions >::minLength ( )

staticconstexpr

Get minimal length that is required to serialise field of this type.

Returns: Minimal number of bytes required serialise the field value.

◆ read()

template<typename TFieldBase , typename TEnum , typename... TOptions>

template<typename TIter >

ErrorStatus comms::field::EnumValue< TFieldBase, TEnum, TOptions >::read	(	TIter &	iter,
		std::size_t	size
	)

Read field value from input data sequence.

Parameters

[in,out]	iter	Iterator to read the data.
[in]	size	Number of bytes available for reading.

Returns: Status of read operation.

Postcondition: Iterator is advanced.

◆ readData() [1/2]

template<typename... TOptions>

template<typename T , typename TIter >

static T comms::Field< TOptions >::readData ( TIter & iter )

staticprotectedinherited

Read data from input buffer.

Use this function to read data from the intput buffer maintained by the caller. The endianness of the data will be as specified in options of the class.

Template Parameters

T	Return type
TIter	Type of input iterator

Parameters

[in,out] iter Input iterator.

Returns: The integral type value.

Precondition: TSize <= sizeof(T); The iterator must be valid and can be successfully dereferenced and incremented at least sizeof(T) times.

Postcondition: The iterator is advanced.

Note: Thread safety: Safe for distinct stream buffers, unsafe otherwise.

◆ readData() [2/2]

template<typename... TOptions>

template<typename T , std::size_t TSize, typename TIter >

static T comms::Field< TOptions >::readData ( TIter & iter )

staticprotectedinherited

Read partial data from input buffer.

Use this function to read data from the intput buffer maintained by the caller. The endianness of the data will be as specified in options of the class.

Template Parameters

T	Return type
TSize	number of bytes to read
TIter	Type of input iterator

Parameters

[in,out] iter Input iterator.

Returns: The integral type value.

Precondition: TSize <= sizeof(T); The iterator must be valid and can be successfully dereferenced and incremented at least TSize times.

Postcondition: The internal pointer of the stream buffer is advanced.

Note: Thread safety: Safe for distinct stream buffers, unsafe otherwise.

◆ readNoStatus()

template<typename TFieldBase , typename TEnum , typename... TOptions>

template<typename TIter >

void comms::field::EnumValue< TFieldBase, TEnum, TOptions >::readNoStatus ( TIter & iter )

Read field value from input data sequence without error check and status report.

Similar to read(), but doesn't perform any correctness checks and doesn't report any failures.

Parameters

[in,out] iter Iterator to read the data.

Postcondition: Iterator is advanced.

◆ refresh()

template<typename TFieldBase , typename TEnum , typename... TOptions>

bool comms::field::EnumValue< TFieldBase, TEnum, TOptions >::refresh ( )

Refresh the field's value.

Returns: true if the value has been updated, false otherwise

◆ setForcedLength()

template<typename TFieldBase , typename TEnum , typename... TOptions>

void comms::field::EnumValue< TFieldBase, TEnum, TOptions >::setForcedLength ( int len )

Force serialization length of the field.

Available only when comms::option::def::AvailableLengthLimit option is used for field definition.

Parameters

[in]

len

Forced serialization length.

0 means default serialization length determined by the storage type
positive value means limit of the serialization length
negative value means the length is determined by the stored value

◆ setValue()

template<typename TFieldBase , typename TEnum , typename... TOptions>

template<typename U >

void comms::field::EnumValue< TFieldBase, TEnum, TOptions >::setValue ( U && val )

Set value.

Implemented as re-assigning to value(), but can be overriden in the derived class.

◆ setVersion()

template<typename TFieldBase , typename TEnum , typename... TOptions>

bool comms::field::EnumValue< TFieldBase, TEnum, TOptions >::setVersion ( VersionType version )

Default implementation of version update.

Returns: true in case the field contents have changed, false otherwise

◆ valid()

template<typename... TOptions>

static constexpr bool comms::Field< TOptions >::valid ( )

staticconstexprinherited

Default validity check.

Always returns true, can be overriden by the derived class

Returns: Always true

◆ write()

template<typename TFieldBase , typename TEnum , typename... TOptions>

template<typename TIter >

ErrorStatus comms::field::EnumValue< TFieldBase, TEnum, TOptions >::write	(	TIter &	iter,
		std::size_t	size
	)		const

Write current field value to output data sequence.

Parameters

[in,out]	iter	Iterator to write the data.
[in]	size	Maximal number of bytes that can be written.

Returns: Status of write operation.

Postcondition: Iterator is advanced.

◆ writeData() [1/2]

template<typename... TOptions>

template<typename T , typename TIter >

static void comms::Field< TOptions >::writeData	(	T	value,
		TIter &	iter
	)

staticprotectedinherited

Write data into the output buffer.

Use this function to write data to the the buffer maintained by the caller. The endianness of the data will be as specified in the options provided to the class.

Template Parameters

T	Type of the value to write. Must be integral.
Type	of output iterator

Parameters

[in]	value	Integral type value to be written.
[in,out]	iter	Output iterator.

Precondition: The iterator must be valid and can be successfully dereferenced and incremented at least sizeof(T) times.

Postcondition: The iterator is advanced.

Note: Thread safety: Safe for distinct buffers, unsafe otherwise.

◆ writeData() [2/2]

template<typename... TOptions>

template<std::size_t TSize, typename T , typename TIter >

static void comms::Field< TOptions >::writeData	(	T	value,
		TIter &	iter
	)

staticprotectedinherited

Write partial data into the output buffer.

Use this function to write partial data to the buffer maintained by the caller. The endianness of the data will be as specified the class options.

Template Parameters

TSize	Length of the value in bytes known in compile time.
T	Type of the value to write. Must be integral.
TIter	Type of output iterator

Parameters

[in]	value	Integral type value to be written.
[in,out]	iter	Output iterator.

Precondition: TSize <= sizeof(T); The iterator must be valid and can be successfully dereferenced and incremented at least TSize times.

Postcondition: The iterator is advanced.

Note: Thread safety: Safe for distinct buffers, unsafe otherwise.

◆ writeNoStatus()

template<typename TFieldBase , typename TEnum , typename... TOptions>

template<typename TIter >

void comms::field::EnumValue< TFieldBase, TEnum, TOptions >::writeNoStatus ( TIter & iter ) const

Write current field value to output data sequence without error check and status report.

Similar to write(), but doesn't perform any correctness checks and doesn't report any failures.

Parameters

[in,out] iter Iterator to write the data.

Postcondition: Iterator is advanced.

Friends And Related Symbol Documentation

◆ isEnumValue()

template<typename T >

constexpr bool isEnumValue ( )

Template Parameters

T Any type.

Returns: true in case provided type is any variant of EnumValue

◆ operator!=()

template<typename TFieldBase , typename TEnum , typename... TOptions>

bool operator!=	(	const EnumValue< TFieldBase, TEnum, TOptions... > &	field1,
		const EnumValue< TFieldBase, TEnum, TOptions... > &	field2
	)

Parameters

[in]	field1	First field.
[in]	field2	Second field.

Returns: true in case fields are NOT equal, false otherwise.

◆ operator<()

template<typename TFieldBase , typename TEnum , typename... TOptions>

bool operator<	(	const EnumValue< TFieldBase, TEnum, TOptions... > &	field1,
		const EnumValue< TFieldBase, TEnum, TOptions... > &	field2
	)

Parameters

[in]	field1	First field.
[in]	field2	Second field.

Returns: true in case value of the first field is lower than than the value of the second.

◆ operator==()

template<typename TFieldBase , typename TEnum , typename... TOptions>

bool operator==	(	const EnumValue< TFieldBase, TEnum, TOptions... > &	field1,
		const EnumValue< TFieldBase, TEnum, TOptions... > &	field2
	)

Parameters

[in]	field1	First field.
[in]	field2	Second field.

Returns: true in case fields are equal, false otherwise.

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

include/comms/field/EnumValue.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Related Symbols

Member Typedef Documentation

◆ FieldType

◆ ValueType

Member Function Documentation

◆ canWrite()

◆ getForcedLength()

◆ getValue()

◆ getVersion()

◆ hasVarLength()

◆ length()

◆ maxLength()

◆ minLength()

◆ read()

◆ readData() [1/2]

◆ readData() [2/2]

◆ readNoStatus()

◆ refresh()

◆ setForcedLength()

◆ setValue()

◆ setVersion()

◆ valid()

◆ write()

◆ writeData() [1/2]

◆ writeData() [2/2]

◆ writeNoStatus()

Friends And Related Symbol Documentation

◆ isEnumValue()

◆ operator!=()

◆ operator<()

◆ operator==()