chrono::synchrono::SynSimulationMessage Class Reference

Description

This class contains diagnostic and simulation configuration based information that is typically passed between CommunicationManagers in the initialization phase.

#include <SynSimulationMessage.h>

Inheritance diagram for chrono::synchrono::SynSimulationMessage:
Collaboration diagram for chrono::synchrono::SynSimulationMessage:

Public Member Functions

 SynSimulationMessage (unsigned int source_id, unsigned int destination_id)
 Constructor. More...
 
virtual ~SynSimulationMessage ()
 Destroy the SynMessage object.
 
virtual void ConvertFromFlatBuffers (const SynFlatBuffers::Message *message) override
 Converts a received flatbuffer message to a SynMessage. More...
 
virtual FlatBufferMessage ConvertToFlatBuffers (flatbuffers::FlatBufferBuilder &builder) override
 Converts this object to a flatbuffer message. More...
 
- Public Member Functions inherited from chrono::synchrono::SynMessage
virtual ~SynMessage ()
 Destroy the SynMessage object.
 
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

◆ SynSimulationMessage()

chrono::synchrono::SynSimulationMessage::SynSimulationMessage ( unsigned int  source_id,
unsigned int  destination_id 
)

Constructor.

Constructors.

Parameters
source_idthe id of the source to which the message is sent from
destination_idthe id of the destination to which the message is sent to

Member Function Documentation

◆ ConvertFromFlatBuffers()

void chrono::synchrono::SynSimulationMessage::ConvertFromFlatBuffers ( const SynFlatBuffers::Message *  message)
overridevirtual

Converts a received flatbuffer message to a SynMessage.

Parameters
messagethe flatbuffer message to convert to a SynMessage

Implements chrono::synchrono::SynMessage.

◆ ConvertToFlatBuffers()

FlatBufferMessage chrono::synchrono::SynSimulationMessage::ConvertToFlatBuffers ( flatbuffers::FlatBufferBuilder &  builder)
overridevirtual

Converts this object to a flatbuffer message.

Generate FlatBuffers message from this message's state.

Parameters
buildera flatbuffer builder to construct the message with
Returns
FlatBufferMessage the constructed flatbuffer message

Implements chrono::synchrono::SynMessage.


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