Description
Description class that holds description information for a SynWheeledVehicle.
#include <SynWheeledVehicleMessage.h>
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) 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 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 | |
Additional Inherited Members |
Constructor & Destructor Documentation
◆ SynWheeledVehicleDescriptionMessage()
chrono::synchrono::SynWheeledVehicleDescriptionMessage::SynWheeledVehicleDescriptionMessage | ( | SynAgentID | source_id, |
SynAgentID | destination_id, | ||
const std::string & | json = "" |
||
) |
Constructor.
- Parameters
-
source_id the id of the source to which the message is sent from destination_id the id of the destination to which the message is sent to json the json specification file used to create an agent
Member Function Documentation
◆ ConvertFromFlatBuffers()
|
overridevirtual |
Converts a received flatbuffer message to a SynMessage.
Generate agent description from FlatBuffers message.
- Parameters
-
message the flatbuffer message to convert to a SynMessage
Cast from SynFlatBuffers::Message to SynFlatBuffers::Agent::WheeledVehicle::Description
Implements chrono::synchrono::SynMessage.
◆ ConvertToFlatBuffers()
|
overridevirtual |
Converts this object to a flatbuffer message.
Generate FlatBuffers message from this agent's description.
- Parameters
-
builder a 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_wheels the 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_file filename for the chassis zombie visualization wheel_vis_file filename for the wheel zombie visualization tire_vis_file filename 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
-
filename the 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