sbepp::group_traits< T > Class Template Reference

Provides various traits/attributes of a <group> element. More...

Public Types
template<typename Byte >
using	value_type = GroupType<Byte>
	Representation type.
template<typename Byte >
using	dimension_type = HeaderType<Byte>
	Group dimension composite type.
using	dimension_type_tag = HeaderTag
	Dimension composite tag.
template<typename Byte >
using	entry_type = EntryType<Byte>
	Group entry type.

Static Public Member Functions
static constexpr const char *	name () noexcept
	Returns name attribute.
static constexpr const char *	description () noexcept
	Returns description attribute.
static constexpr member_id_t	id () noexcept
	Returns id attribute.
static constexpr block_length_t	block_length () noexcept
	Returns blockLength attribute.
static constexpr const char *	semantic_type () noexcept
	Returns semanticType attribute.
static constexpr version_t	since_version () noexcept
	Returns addedSince attribute.
static constexpr version_t	deprecated () noexcept
	Returns deprecated attribute. Available only if provided in schema.
static constexpr std::size_t	size_bytes (const NumInGroupType num_in_group,...) noexcept
	Returns number of bytes required to represent the group in given configuration.

Detailed Description

template<typename T>
class sbepp::group_traits< T >

Provides various traits/attributes of a <group> element.

For example: sbepp::group_traits<message_tag::group_name>::since_version();

Template Parameters

T

group tag

Member Typedef Documentation

dimension_type

template<typename T >

template<typename Byte >

using sbepp::group_traits< T >::dimension_type = HeaderType<Byte>

Group dimension composite type.

Template Parameters

Byte

byte type

entry_type

template<typename T >

template<typename Byte >

using sbepp::group_traits< T >::entry_type = EntryType<Byte>

Group entry type.

Template Parameters

Byte

byte type

value_type

template<typename T >

template<typename Byte >

using sbepp::group_traits< T >::value_type = GroupType<Byte>

Representation type.

Template Parameters

Byte

byte type

Member Function Documentation

size_bytes()

template<typename T >

static constexpr std::size_t sbepp::group_traits< T >::size_bytes ( const NumInGroupType num_in_group, ... )

staticconstexprnoexcept

Returns number of bytes required to represent the group in given configuration.

Parameters

num_in_group	number of entries in the group
...	parameter list depends on the group structure

Returns

size in bytes

Check message_traits::size_bytes() to see how trailing parameter list is built.

---

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

• sbepp.hpp