chrono::synchrono::SynWheeledVehicleDescriptionMessage Class Reference

Description

Description class that holds description information for a SynWheeledVehicle.

#include <SynWheeledVehicleMessage.h>

Inheritance diagram for chrono::synchrono::SynWheeledVehicleDescriptionMessage:
Collaboration diagram for chrono::synchrono::SynWheeledVehicleDescriptionMessage:

Public Member Functions

 SynWheeledVehicleDescriptionMessage (SynAgentID source_id, SynAgentID destination_id, const std::string &json="")
 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 SetZombieVisualizationFilesFromJSON (const std::string &filename)
 Set the visualization files from a JSON specification file. More...
 
void SetVisualizationFiles (const std::string &chassis_vis_file, const std::string &wheel_vis_file, const std::string &tire_vis_file)
 Set the visualization files used for zombie visualization. More...
 
void SetNumWheels (int num_wheels)
 Set the total number of wheels for this vehicle. 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

std::string json = ""
 the json specification file that is used to create an agent
 
std::string chassis_vis_file = ""
 file name for chassis zombie visualization
 
std::string wheel_vis_file = ""
 file name for wheel zombie visualization
 
std::string tire_vis_file = ""
 file name for tire zombie visualization
 
int num_wheels = 0
 number of wheels the zombie vehicle has
 
- 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

◆ SynWheeledVehicleDescriptionMessage()

chrono::synchrono::SynWheeledVehicleDescriptionMessage::SynWheeledVehicleDescriptionMessage ( SynAgentID  source_id,
SynAgentID  destination_id,
const std::string &  json = "" 
)

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
jsonthe json specification file used to create an agent

Member Function Documentation

◆ ConvertFromFlatBuffers()

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

Converts a received flatbuffer message to a SynMessage.

Generate agent description from FlatBuffers message.

Parameters
messagethe flatbuffer message to convert to a SynMessage

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

Implements chrono::synchrono::SynMessage.

◆ ConvertToFlatBuffers()

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

Converts this object to a flatbuffer message.

Generate FlatBuffers message from this agent's description.

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

Implements chrono::synchrono::SynMessage.

◆ SetNumWheels()

void chrono::synchrono::SynWheeledVehicleDescriptionMessage::SetNumWheels ( int  num_wheels)

Set the total number of wheels for this vehicle.

Parameters
num_wheelsthe total number of wheels on the vehicle

◆ SetVisualizationFiles()

void chrono::synchrono::SynWheeledVehicleDescriptionMessage::SetVisualizationFiles ( const std::string &  chassis_vis_file,
const std::string &  wheel_vis_file,
const std::string &  tire_vis_file 
)

Set the visualization files used for zombie visualization.

Parameters
chassis_vis_filefilename for the chassis zombie visualization
wheel_vis_filefilename for the wheel zombie visualization
tire_vis_filefilename for the tire zombie visualization

◆ SetZombieVisualizationFilesFromJSON()

void chrono::synchrono::SynWheeledVehicleDescriptionMessage::SetZombieVisualizationFilesFromJSON ( const std::string &  filename)

Set the visualization files from a JSON specification file.

Parameters
filenamethe json specification file

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