chrono::synchrono::SynEnvironmentMessage Class Reference

Description

Used to send the initial description for an environment agent.

#include <SynEnvironmentMessage.h>

Inheritance diagram for chrono::synchrono::SynEnvironmentMessage:
Collaboration diagram for chrono::synchrono::SynEnvironmentMessage:

Public Member Functions

 SynEnvironmentMessage (int rank, std::shared_ptr< SynEnvironmentMessageState > state=nullptr)
 
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< SynMessageStateGetState () override
 Get the SynMessageState object. More...
 
virtual void DescriptionFromMessage (const SynFlatBuffers::Message *message) override
 Generates and sets the description of the agent from flatbuffer message. More...
 
virtual FlatBufferMessage MessageFromDescription (flatbuffers::FlatBufferBuilder &builder) override
 Generates a SynFlatBuffers::Message from the agent description. More...
 
- Public Member Functions inherited from chrono::synchrono::SynAgentMessage
 SynAgentMessage (int rank, SynMessageType type, std::string json="")
 Construct a new SynAgentMessage object. More...
 
std::shared_ptr< SynAgentDescriptionGetDescription ()
 Get the SynAgentDescription object. More...
 
void SetJSON (const std::string &json)
 
- Public Member Functions inherited from chrono::synchrono::SynMessage
 SynMessage (int rank, SynMessageType type)
 Construct a new SynMessage object. More...
 
virtual ~SynMessage ()
 Destroy the SynMessage object.
 
SynMessageType GetType ()
 Get the SynMessageType object. More...
 
unsigned int GetRank ()
 Get the rank from which this message originates. More...
 

Additional Inherited Members

- Protected Attributes inherited from chrono::synchrono::SynAgentMessage
std::shared_ptr< SynAgentDescriptionm_description
 handle to the agent description
 
- Protected Attributes inherited from chrono::synchrono::SynMessage
int m_rank
 rank of which sent or maintains this message
 
SynMessageType m_type
 type of which this message is
 

Member Function Documentation

◆ DescriptionFromMessage()

void chrono::synchrono::SynEnvironmentMessage::DescriptionFromMessage ( const SynFlatBuffers::Message *  message)
overridevirtual

Generates and sets the description of the agent from flatbuffer message.

Generate agent description from FlatBuffers message.

Parameters
messagethe flatbuffer message to convert to a SynAgentDescription object

Cast from SynFlatBuffers::Message to SynFlatBuffers::Agent::Description

Reimplemented from chrono::synchrono::SynAgentMessage.

◆ GetState()

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

Get the SynMessageState object.

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

Implements chrono::synchrono::SynMessage.

◆ MessageFromDescription()

FlatBufferMessage chrono::synchrono::SynEnvironmentMessage::MessageFromDescription ( flatbuffers::FlatBufferBuilder &  builder)
overridevirtual

Generates a SynFlatBuffers::Message from the agent description.

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

Implements chrono::synchrono::SynAgentMessage.

◆ MessageFromState()

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

Generates a SynFlatBuffers::Message from the message state.

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

Implements chrono::synchrono::SynMessage.

◆ StateFromMessage()

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

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

Parameters
messagethe flatbuffer message to convert to a MessageState object

Reimplemented from chrono::synchrono::SynAgentMessage.


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