Use this Stream Meta Type if your sample data will be any of this type: bool, uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double or plain array T[], std::array, std::vector of them. More...

#include <streammetatypeplain.h>

Inherits adtf::streaming::ant::stream_meta_type_plain.

Static Public Member Functions
static void	SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)

static tResult	IsCompatible (const adtf::streaming::IStreamType &oTypeToCheck, const adtf::streaming::IStreamType &oTypeExpected)
	Compares the `oTypeExpected` Stream Type with the `oTypeToCheck`.

Static Public Member Functions inherited from adtf::streaming::ant::stream_meta_type_plain
static void	SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)

static tResult	IsCompatible (const adtf::streaming::IStreamType &oTypeToCheck, const adtf::streaming::IStreamType &oTypeExpected)
	Compares the `oTypeExpected` Stream Type with the `oTypeToCheck`.

Static Public Attributes
static constexpr const char *const	ArraySize = "array_size"
	Array size for the used type.

static constexpr const char *const	DataEndianess = "data_endianess"
	Identify the endianess of the content. This is relevant for all value types greater than 1 byte.

Static Public Attributes inherited from adtf::streaming::ant::stream_meta_type_plain
static constexpr const tChar *const	MetaTypeName = "adtf/plaintype"
	StreamMetaTypeName for plaintype.

static constexpr const tChar *const	PlainTypeProperty = "c-type"
	c-type Property for plaintype Stream Meta Type

Detailed Description

Use this Stream Meta Type if your sample data will be any of this type: bool, uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double or plain array T[], std::array, std::vector of them.

brings latest penguin::stream_meta_type_plain to the users scope

Concept template to create the "adtf/plaintype" Stream Meta Type for the generator template stream_meta_type.

Member Function Documentation

◆ IsCompatible()

static tResult adtf::streaming::penguin::stream_meta_type_plain::IsCompatible	(	const adtf::streaming::IStreamType &	oTypeToCheck,
		const adtf::streaming::IStreamType &	oTypeExpected )

inlinestatic

Compares the oTypeExpected Stream Type with the oTypeToCheck.

Compatible to all other stream types of any stream meta type, where the following conditions are met:

the property value of the properties adtf::streaming::ant::stream_meta_type_plain::PlainTypeProperty are equal in both types.
the property value of the properties ArraySize are equal or the expected ArraySize is 0
the property value of the properties DataEndianess are equal in both types if value type is greater than 1 byte

Parameters

[in]	oTypeToCheck	The incoming type to check.
[in]	oTypeExpected	The expected type which values are more significant.

Return values

ERR_NOERROR types are compatible

◆ SetProperties()

static void adtf::streaming::penguin::stream_meta_type_plain::SetProperties ( const adtf::ucom::iobject_ptr< adtf::base::IProperties > & pProperties )

inlinestatic

Property setter for plaintype.

Member Data Documentation

◆ ArraySize

const char* const adtf::streaming::penguin::stream_meta_type_plain::ArraySize = "array_size"

staticconstexpr

Array size for the used type.

Array size for the used type is only relevant for array types:

for single arithmetic type (bool, all ints, float, double) the value is 1
for dynamic arrays (i.e. std::vector<bool>, all ints, float, double) the value is 0 (content is dynamic)
for static arrays (i.e std::array<bool, N>, all ints, float, double) the value is N (content is fixed array size)

◆ DataEndianess

const char* const adtf::streaming::penguin::stream_meta_type_plain::DataEndianess = "data_endianess"

staticconstexpr

Identify the endianess of the content. This is relevant for all value types greater than 1 byte.

The endianess of the content is relevant for all value types greater than 1 byte and is only set if current platform endianess is different to PLATFORM_LITTLE_ENDIAN_8.

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

src/libraries/streaming3/include/adtfstreaming3/streammetatypeplain.h

Static Public Member Functions