chrono::synchrono::SynSCMMessage Class Reference


Class that wraps data contained in a message about Soil Contact Model (SCM) Deformable terrain.

#include <SynSCMMessage.h>

Inheritance diagram for chrono::synchrono::SynSCMMessage:
Collaboration diagram for chrono::synchrono::SynSCMMessage:

Public Member Functions

 SynSCMMessage (int rank, std::shared_ptr< SynSCMTerrainState > state=nullptr)
 Construct a new SynSCMMessage 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< SynMessageStateGetState () override
 Get the SynMessageState object. More...
std::shared_ptr< SynSCMTerrainState > GetSCMState ()
 Get the SynSCMTerrainState 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

◆ SynSCMMessage()

chrono::synchrono::SynSCMMessage::SynSCMMessage ( int  rank,
std::shared_ptr< SynSCMTerrainState >  state = nullptr 

Construct a new SynSCMMessage object.


rankthe rank of this message

Member Function Documentation

◆ GetSCMState()

std::shared_ptr<SynSCMTerrainState> chrono::synchrono::SynSCMMessage::GetSCMState ( )

Get the SynSCMTerrainState object.

std::shared_ptr<SynSCMTerrainState> the state associated with this message

◆ GetState()

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

Get the SynMessageState object.

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

Implements chrono::synchrono::SynMessage.

◆ MessageFromState()

FlatBufferMessage chrono::synchrono::SynSCMMessage::MessageFromState ( flatbuffers::FlatBufferBuilder &  builder)

Generates a SynFlatBuffers::Message from the message state.

Generate FlatBuffers message from this message's state.

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

Implements chrono::synchrono::SynMessage.

◆ StateFromMessage()

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

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

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/SynSCMMessage.h
  • /builds/uwsbel/chrono/src/chrono_synchrono/flatbuffer/message/SynSCMMessage.cpp