chrono::synchrono::SynSensorMessage Class Reference

Description

Wraps data received from a flatbuffer sensor message into a corresponding C++ class.

#include <SynSensorMessage.h>

Inheritance diagram for chrono::synchrono::SynSensorMessage:
Collaboration diagram for chrono::synchrono::SynSensorMessage:

Public Member Functions

 SynSensorMessage (int rank)
 Construct a new SensorMessageState object. More...
 
virtual void StateFromMessage (const SynFlatBuffers::Message *message) override
 Generates and sets the state of this message from flatbuffer message. More...
 
virtual FlatBufferMessage MessageFromState (flatbuffers::FlatBufferBuilder &builder) override
 Generates a SynFlatBuffers::Message from the message state. More...
 
virtual std::shared_ptr< SynMessageState > GetState () override
 Get the SensorMessageState object. More...
 
- Public Member Functions inherited from chrono::synchrono::SynMessage
virtual ~SynMessage ()
 Destroy the SynMessage object.
 
virtual void ConvertFromFlatBuffers (const SynFlatBuffers::Message *message)=0
 Converts a received flatbuffer message to a SynMessage. More...
 
virtual FlatBufferMessage ConvertToFlatBuffers (flatbuffers::FlatBufferBuilder &builder)=0
 Converts this object to a flatbuffer message. More...
 
unsigned int GetSourceID ()
 Get the id of the source of this message. More...
 
void SetSourceID (unsigned int source_id)
 Set the id of the source of this message. More...
 
unsigned int GetDestinationID ()
 Get the id of the destination for this message. More...
 

Additional Inherited Members

- Public Attributes inherited from chrono::synchrono::SynMessage
double time
 simulation time
 
- Protected Member Functions inherited from chrono::synchrono::SynMessage
 SynMessage (unsigned int source_id, unsigned int destination_id)
 Constructor. More...
 
- Protected Attributes inherited from chrono::synchrono::SynMessage
unsigned int m_source_id
 id for the source which sent this message
 
unsigned int m_destination_id
 id for the destination of this message
 

Constructor & Destructor Documentation

◆ SynSensorMessage()

chrono::synchrono::SynSensorMessage::SynSensorMessage ( int  rank)

Construct a new SensorMessageState object.

Constructors.

Parameters
rankthe rank of this message

Member Function Documentation

◆ GetState()

virtual std::shared_ptr<SynMessageState> chrono::synchrono::SynSensorMessage::GetState ( )
inlineoverridevirtual

Get the SensorMessageState object.

Returns
std::shared_ptr<SensorMessageState> the state associated with this message

◆ MessageFromState()

FlatBufferMessage chrono::synchrono::SynSensorMessage::MessageFromState ( flatbuffers::FlatBufferBuilder &  builder)
overridevirtual

Generates a SynFlatBuffers::Message from the message state.

Generate FlatBuffers message from this message's state.

Parameters
builderthe flatbuffer builder used to construct messages
Returns
flatbuffers::Offset<SynFlatBuffers::Message> the generated message

◆ StateFromMessage()

void chrono::synchrono::SynSensorMessage::StateFromMessage ( const SynFlatBuffers::Message *  message)
overridevirtual

Generates and sets the state of this message from flatbuffer message.

Generate state from FlatBuffers message.

Parameters
messagethe flatbuffer message to convert to a MessageState object

The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_synchrono/flatbuffer/message/SynSensorMessage.h
  • /builds/uwsbel/chrono/src/chrono_synchrono/flatbuffer/message/SynSensorMessage.cpp