commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T > Struct Template Reference

Input metadata structure returned by accessor methods. More...

#include <commrat/module/metadata/input_metadata_accessors.hpp>

Static Public Member Functions
static constexpr const char *	type_name ()

Public Attributes
uint64_t	timestamp
	Message timestamp (from TimsHeader)
uint32_t	sequence_number
	Message sequence number.
uint32_t	message_id
	Message type ID.
bool	is_new_data
	True if freshly received, false if stale/reused.
bool	is_valid
	True if getData succeeded, false if failed.

Detailed Description

template<typename ModuleType>
template<typename T>
struct commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >

Input metadata structure returned by accessor methods.

Contains timestamp, sequence number, and freshness information about a received input message. Available for modules with continuous inputs.

Template Parameters

T	The payload type of the input

Definition at line 45 of file input_metadata_accessors.hpp.

Member Function Documentation

type_name()

template<typename ModuleType >

template<typename T >

static constexpr const char * commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >::type_name ( )

inlinestaticconstexpr

Examples

/home/runner/work/CommRaT/CommRaT/include/commrat/module/metadata/input_metadata_accessors.hpp.

Definition at line 53 of file input_metadata_accessors.hpp.

Member Data Documentation

is_new_data

template<typename ModuleType >

template<typename T >

bool commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >::is_new_data

True if freshly received, false if stale/reused.

Examples

/home/runner/work/CommRaT/CommRaT/include/commrat/module/metadata/input_metadata_accessors.hpp.

Definition at line 49 of file input_metadata_accessors.hpp.

is_valid

template<typename ModuleType >

template<typename T >

bool commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >::is_valid

True if getData succeeded, false if failed.

Examples

/home/runner/work/CommRaT/CommRaT/include/commrat/module/metadata/input_metadata_accessors.hpp.

Definition at line 50 of file input_metadata_accessors.hpp.

message_id

template<typename ModuleType >

template<typename T >

uint32_t commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >::message_id

Message type ID.

Examples

/home/runner/work/CommRaT/CommRaT/include/commrat/module/metadata/input_metadata_accessors.hpp.

Definition at line 48 of file input_metadata_accessors.hpp.

sequence_number

template<typename ModuleType >

template<typename T >

uint32_t commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >::sequence_number

Message sequence number.

Examples

/home/runner/work/CommRaT/CommRaT/include/commrat/module/metadata/input_metadata_accessors.hpp.

Definition at line 47 of file input_metadata_accessors.hpp.

timestamp

template<typename ModuleType >

template<typename T >

uint64_t commrat::InputMetadataAccessors< ModuleType >::InputMetadata< T >::timestamp

Message timestamp (from TimsHeader)

Examples

/home/runner/work/CommRaT/CommRaT/include/commrat/module/metadata/input_metadata_accessors.hpp.

Definition at line 46 of file input_metadata_accessors.hpp.

Referenced by commrat::InputMetadataAccessors< ModuleType >::get_input_metadata().

---

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

• commrat/module/metadata/input_metadata_accessors.hpp