chrono::synchrono::SynTrackedVehicleMessage Class Reference

Description

Wraps data from a tracked vehicle state message into a corresponding C++ object.

#include <SynTrackedVehicleMessage.h>

Inheritance diagram for chrono::synchrono::SynTrackedVehicleMessage:

Collaboration diagram for chrono::synchrono::SynTrackedVehicleMessage:

Public Member Functions
	SynTrackedVehicleMessage (int rank, std::string json="", std::shared_ptr< SynTrackedVehicleState > state=nullptr, std::shared_ptr< SynTrackedVehicleDescription > description=nullptr)
	Construct a new SynTrackedVehicleMessage object. More...
	SynTrackedVehicleMessage (int rank, std::shared_ptr< SynTrackedVehicleState > state, std::shared_ptr< SynTrackedVehicleDescription > description=nullptr)
	Construct a new SynTrackedVehicleMessage object Initialize with the passed state and description. 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< SynMessageState >	GetState () override
	Get the SynMessageState object. More...
std::shared_ptr< SynTrackedVehicleState >	GetTrackedState ()
	Get the SynTrackedVehicleState object. More...
virtual void	DescriptionFromMessage (const SynFlatBuffers::Message *message) override
	Generates and sets the agent description from a flatbuffer message. More...
virtual FlatBufferMessage	MessageFromDescription (flatbuffers::FlatBufferBuilder &builder) override
	Generates a SynFlatBuffers::Message from the agent description. More...
std::shared_ptr< SynTrackedVehicleDescription >	GetTrackedDescription ()
	Get the SynTrackedVehicleDescription object. More...
Public Member Functions inherited from chrono::synchrono::SynAgentMessage
	SynAgentMessage (int rank, SynMessageType type, std::string json="")
	Construct a new SynAgentMessage object. More...
std::shared_ptr< SynAgentDescription >	GetDescription ()
	Get the SynAgentDescription object. More...
void	SetJSON (const std::string &json)
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::SynAgentMessage
std::shared_ptr< SynAgentDescription >	m_description
	handle to the agent description
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

SynTrackedVehicleMessage() [1/2]

chrono::synchrono::SynTrackedVehicleMessage::SynTrackedVehicleMessage	(	int	rank,
		std::string	json = "",
		std::shared_ptr< SynTrackedVehicleState >	state = nullptr,
		std::shared_ptr< SynTrackedVehicleDescription >	description = nullptr
	)

Construct a new SynTrackedVehicleMessage object.

Constructors.

Parameters

rank	the rank of this message
json	used when generating the agent description
state	used when wrapping existing state
description	used when wrapping an existing description

SynTrackedVehicleMessage() [2/2]

chrono::synchrono::SynTrackedVehicleMessage::SynTrackedVehicleMessage	(	int	rank,
		std::shared_ptr< SynTrackedVehicleState >	state,
		std::shared_ptr< SynTrackedVehicleDescription >	description = nullptr
	)

Construct a new SynTrackedVehicleMessage object Initialize with the passed state and description.

Parameters

rank	the rank of this message
state	used when wrapping existing state
description	used when wrapping an existing description

Member Function Documentation

DescriptionFromMessage()

void chrono::synchrono::SynTrackedVehicleMessage::DescriptionFromMessage ( const SynFlatBuffers::Message *  message )

overridevirtual

Generates and sets the agent description from a flatbuffer message.

Generate description from FlatBuffers message.

Parameters

message

the flatbuffer message to convert to a SynAgentDescription object

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

Reimplemented from chrono::synchrono::SynAgentMessage.

GetState()

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

inlineoverridevirtual

Get the SynMessageState object.

Returns

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

Implements chrono::synchrono::SynMessage.

GetTrackedDescription()

std::shared_ptr<SynTrackedVehicleDescription> chrono::synchrono::SynTrackedVehicleMessage::GetTrackedDescription ( )

inline

Get the SynTrackedVehicleDescription object.

Returns

std::shared_ptr<SynTrackedVehicleDescription> the description associated with this message

GetTrackedState()

std::shared_ptr<SynTrackedVehicleState> chrono::synchrono::SynTrackedVehicleMessage::GetTrackedState ( )

inline

Get the SynTrackedVehicleState object.

Returns

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

MessageFromDescription()

FlatBufferMessage chrono::synchrono::SynTrackedVehicleMessage::MessageFromDescription ( flatbuffers::FlatBufferBuilder &  builder )

overridevirtual

Generates a SynFlatBuffers::Message from the agent description.

Generate FlatBuffers message from this agent's description.

Parameters

builder

the flatbuffer builder used to construct messages

Returns

flatbuffers::Offset<SynFlatBuffers::Message> the generated message

Implements chrono::synchrono::SynAgentMessage.

MessageFromState()

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

overridevirtual

Generates a SynFlatBuffers::Message from the message state.

Generate FlatBuffers message from this message's state.

Parameters

builder

the flatbuffer builder used to construct messages

Returns

flatbuffers::Offset<SynFlatBuffers::Message> the generated message

Implements chrono::synchrono::SynMessage.

StateFromMessage()

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

overridevirtual

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

Parameters

message

the flatbuffer message to convert to a MessageState object

Reimplemented from chrono::synchrono::SynAgentMessage.

---

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