CommRaT 2.0.0
C++20 Real-Time Messaging Framework
Loading...
Searching...
No Matches
commrat::Message Namespace Reference

Typedefs

template<typename T , MessagePrefix Prefix = MessagePrefix::UserDefined, uint16_t LocalID = AUTO_ID>
using Data = MessageDefinition< T, Prefix, UserSubPrefix::Data, LocalID >
 Data message definition.
 
template<typename T , MessagePrefix Prefix = MessagePrefix::UserDefined, uint16_t LocalID = AUTO_ID>
using Command = MessageDefinition< T, Prefix, UserSubPrefix::Commands, LocalID >
 Command message definition.
 
template<typename T , MessagePrefix Prefix = MessagePrefix::UserDefined, uint16_t LocalID = AUTO_ID>
using Event = MessageDefinition< T, Prefix, UserSubPrefix::Events, LocalID >
 Event message definition.
 

Typedef Documentation

◆ Command

template<typename T , MessagePrefix Prefix = MessagePrefix::UserDefined, uint16_t LocalID = AUTO_ID>
using commrat::Message::Command = typedef MessageDefinition<T, Prefix, UserSubPrefix::Commands, LocalID>

Command message definition.

Usage: using ResetCmd = Message::Command<ResetCommand>; using CalibrateCmd = Message::Command<CalibrateCommand>;

Template Parameters
TPayload type
PrefixMessage prefix (default: UserDefined)
LocalIDLocal message ID (default: AUTO_ID)

Definition at line 68 of file message_helpers.hpp.

◆ Data

template<typename T , MessagePrefix Prefix = MessagePrefix::UserDefined, uint16_t LocalID = AUTO_ID>
using commrat::Message::Data = typedef MessageDefinition<T, Prefix, UserSubPrefix::Data, LocalID>

Data message definition.

Usage: using TempMsg = Message::Data<TemperatureData>; using SensorMsg = Message::Data<SensorData>;

Template Parameters
TPayload type
PrefixMessage prefix (default: UserDefined)
LocalIDLocal message ID (default: AUTO_ID)

Definition at line 48 of file message_helpers.hpp.

◆ Event

template<typename T , MessagePrefix Prefix = MessagePrefix::UserDefined, uint16_t LocalID = AUTO_ID>
using commrat::Message::Event = typedef MessageDefinition<T, Prefix, UserSubPrefix::Events, LocalID>

Event message definition.

Usage: using ErrorEvent = Message::Event<ErrorData>; using WarningEvent = Message::Event<WarningData>;

Template Parameters
TPayload type
PrefixMessage prefix (default: UserDefined)
LocalIDLocal message ID (default: AUTO_ID)

Definition at line 88 of file message_helpers.hpp.