chrono::synchrono::SynSPATMessage Class Reference

Description

Wraps data from a SPAT message into a corresponding C++ object.

#include <SynSPATMessage.h>

Inheritance diagram for chrono::synchrono::SynSPATMessage:
Collaboration diagram for chrono::synchrono::SynSPATMessage:

Public Member Functions

 SynSPATMessage (int rank, std::shared_ptr< SynSPATMessageState > state=nullptr)
 Construct a new SynSPATMessage 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 void setColor (int intersection, int approach, int lane, LaneColor color)
 
virtual std::shared_ptr< SynMessageStateGetState () override
 Get the SynMessageState object. More...
 
std::shared_ptr< SynSPATMessageState > GetSPATState ()
 Get the SynSPATMessageState object. More...
 
- 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::SynMessage
int m_rank
 rank of which sent or maintains this message
 
SynMessageType m_type
 type of which this message is
 

Constructor & Destructor Documentation

◆ SynSPATMessage()

chrono::synchrono::SynSPATMessage::SynSPATMessage ( int  rank,
std::shared_ptr< SynSPATMessageState >  state = nullptr 
)

Construct a new SynSPATMessage object.

Parameters
rankthe rank of this message

Member Function Documentation

◆ GetSPATState()

std::shared_ptr<SynSPATMessageState> chrono::synchrono::SynSPATMessage::GetSPATState ( )
inline

Get the SynSPATMessageState object.

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

◆ GetState()

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

Get the SynMessageState object.

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

Implements chrono::synchrono::SynMessage.

◆ MessageFromState()

FlatBufferMessage chrono::synchrono::SynSPATMessage::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::SynSPATMessage::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

Implements chrono::synchrono::SynMessage.


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