Class cerializer::SetTargetSourceMessage
ClassList > cerializer > SetTargetSourceMessage
A message to set the active target source. More...
#include <serializer.hpp>
Inherits the following classes: cerializer::Message
Public Types inherited from cerializer::Message
| Type | Name |
|---|---|
| typedef std::array< char,(sizeof(FieldTypes)+...)+2 *sizeof(uint16_t)+sizeof(uint8_t)> | BinaryMessage A type alias for the array holding the full binary message, including headers and footers. |
| typedef std::array< char, 4+(std::get< 0 >(formatSize< FieldTypes >())+...)> | MessageFormat A type alias for the array holding the message's format string. |
Public Attributes
| Type | Name |
|---|---|
| const TargetSource | source The selected target source. |
Public Static Attributes inherited from cerializer::Message
| Type | Name |
|---|---|
| const bool | registered = /* multi line expression */A static flag that triggers registration with the MessageMaker factory upon program start. |
Public Functions
| Type | Name |
|---|---|
| constexpr | SetTargetSourceMessage (TargetSource initial_source) noexcept Constructs a new SetTargetSourceMessage . |
| constexpr std::array< char, Size()> | encode () const Encodes the message fields into a character array. |
Public Functions inherited from cerializer::Message
| Type | Name |
|---|---|
| virtual constexpr uint8_t | Code () override Gets the unique code for this message type. |
| constexpr BinaryMessage | ToBinary () const Generates the binary representation of the message. This method serializes the message fields, adds the magic head/foot and type code. |
Public Functions inherited from cerializer::BasePacket
| Type | Name |
|---|---|
| virtual constexpr uint8_t | Code () = 0 Gets the unique 8-bit code that identifies the message type. |
| virtual | ~BasePacket () = default |
Public Static Functions inherited from cerializer::Message
| Type | Name |
|---|---|
| constexpr MessageFormat | Format () Generates the format string for the message. |
| constexpr Derived | LoadBinary (BinaryMessage & binaryData) Deserializes a message from a character array. |
| constexpr Derived | LoadBinary (const std::span< char > & binaryData) Deserializes a message from a span of characters. |
| constexpr unsigned int | Size () Gets the total size of the message payload in bytes. |
| constexpr uint8_t | Type () Gets the unique code for this message type (static version). |
Detailed Description
This message is sent to the microcontroller to command it to switch between different targeting systems like static, radar, or CV.
Public Attributes Documentation
variable source
The selected target source.
const TargetSource cerializer::SetTargetSourceMessage::source;
Public Functions Documentation
function SetTargetSourceMessage
Constructs a new SetTargetSourceMessage .
inline constexpr cerializer::SetTargetSourceMessage::SetTargetSourceMessage (
TargetSource initial_source
) noexcept
Parameters:
initial_sourceThe target source to be set.
function encode
Encodes the message fields into a character array.
inline constexpr std::array< char, Size ()> cerializer::SetTargetSourceMessage::encode () const
Returns:
A std::array<char, Size()> containing the serialized payload.
The documentation for this class was generated from the following file serializer.hpp