chrono::synchrono::SynWheeledVehicleStateMessage Class Reference


State class that holds state information for a SynWheeledVehicle.

#include <SynWheeledVehicleMessage.h>

Inheritance diagram for chrono::synchrono::SynWheeledVehicleStateMessage:
Collaboration diagram for chrono::synchrono::SynWheeledVehicleStateMessage:

Public Member Functions

 SynWheeledVehicleStateMessage (AgentKey source_key, AgentKey destination_key)
 Constructor. More...
virtual void ConvertFromFlatBuffers (const SynFlatBuffers::Message *message) override
 Converts a received flatbuffer message to a SynMessage. More...
virtual FlatBufferMessage ConvertToFlatBuffers (flatbuffers::FlatBufferBuilder &builder) const override
 Converts this object to a flatbuffer message. More...
void SetState (double time, SynPose chassis, std::vector< SynPose > wheels)
 Set the state variables. More...
- Public Member Functions inherited from chrono::synchrono::SynMessage
virtual ~SynMessage ()
 Destroy the SynMessage object.
AgentKey GetSourceKey ()
 Get the key of the source of this message. More...
void SetSourceKey (AgentKey source_key)
 Set the key of the source of this message. More...
AgentKey GetDestinationKey ()
 Get the key of the destination for this message. More...
SynFlatBuffers::Type GetMessageType ()
void SetMessageType (SynFlatBuffers::Type msg_type)

Public Attributes

SynPose chassis
 vehicle's chassis pose
std::vector< SynPosewheels
 vector of vehicle's wheels
- Public Attributes inherited from chrono::synchrono::SynMessage
double time
 simulation time

Additional Inherited Members

- Protected Member Functions inherited from chrono::synchrono::SynMessage
 SynMessage (AgentKey source_key=AgentKey(), AgentKey destination_key=AgentKey())
 Constructor. More...
- Protected Attributes inherited from chrono::synchrono::SynMessage
AgentKey m_source_key
 key for the source which sent this message
AgentKey m_destination_key
 key for the destination of this message
SynFlatBuffers::Type m_msg_type
 Type of message that we contain.

Constructor & Destructor Documentation

◆ SynWheeledVehicleStateMessage()

chrono::synchrono::SynWheeledVehicleStateMessage::SynWheeledVehicleStateMessage ( AgentKey  source_key,
AgentKey  destination_key 


source_keythe id of the source to which the message is sent from
destination_keythe id of the destination to which the message is sent to

Member Function Documentation

◆ ConvertFromFlatBuffers()

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

Converts a received flatbuffer message to a SynMessage.

messagethe flatbuffer message to convert to a SynMessage

Implements chrono::synchrono::SynMessage.

◆ ConvertToFlatBuffers()

FlatBufferMessage chrono::synchrono::SynWheeledVehicleStateMessage::ConvertToFlatBuffers ( flatbuffers::FlatBufferBuilder &  builder) const

Converts this object to a flatbuffer message.

Generate FlatBuffers message from this message's state.

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

Implements chrono::synchrono::SynMessage.

◆ SetState()

void chrono::synchrono::SynWheeledVehicleStateMessage::SetState ( double  time,
SynPose  chassis,
std::vector< SynPose wheels 

Set the state variables.

timesimulation time
chassisvehicle's chassis pose
wheelsvector of the vehicle's wheel poses

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