chrono::synchrono::SynTrackedVehicleStateMessage Class Reference

Description

State class that holds state information for a SynTrackedVehicleAgent.

#include <SynTrackedVehicleMessage.h>

Inheritance diagram for chrono::synchrono::SynTrackedVehicleStateMessage:
Collaboration diagram for chrono::synchrono::SynTrackedVehicleStateMessage:

Public Member Functions

 SynTrackedVehicleStateMessage (SynAgentID source_id, SynAgentID destination_id)
 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 > track_shoes, std::vector< SynPose > sprockets, std::vector< SynPose > idlers, std::vector< SynPose > road_wheels)
 Set the state variables. More...
 
- Public Member Functions inherited from chrono::synchrono::SynMessage
virtual ~SynMessage ()
 Destroy the SynMessage object.
 
unsigned int GetSourceID () const
 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 () const
 Get the id 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< SynPosetrack_shoes
 vector of vehicle's track shoes
 
std::vector< SynPosesprockets
 vector of vehicle's sprockets
 
std::vector< SynPoseidlers
 vector of vehicle's idlers
 
std::vector< SynPoseroad_wheels
 vector of vehicle's road wheels
 
- Public Attributes inherited from chrono::synchrono::SynMessage
double time
 simulation time
 

Additional Inherited Members

- 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
 
SynFlatBuffers::Type m_msg_type
 Type of message that we contain.
 

Constructor & Destructor Documentation

◆ SynTrackedVehicleStateMessage()

chrono::synchrono::SynTrackedVehicleStateMessage::SynTrackedVehicleStateMessage ( SynAgentID  source_id,
SynAgentID  destination_id 
)

Constructor.

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::SynTrackedVehicleStateMessage::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::SynTrackedVehicleStateMessage::ConvertToFlatBuffers ( flatbuffers::FlatBufferBuilder &  builder) const
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.

◆ SetState()

void chrono::synchrono::SynTrackedVehicleStateMessage::SetState ( double  time,
SynPose  chassis,
std::vector< SynPose track_shoes,
std::vector< SynPose sprockets,
std::vector< SynPose idlers,
std::vector< SynPose road_wheels 
)

Set the state variables.

Parameters
timesimulation time
chassisvehicle's chassis pose
track_shoesvehicle's track shoe poses
sprocketsvehicle's sprocket poses
idlersvehicle's idler poses
road_wheelsvehicle's road wheel poses

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