JAUS::SetTravelSpeed Class Reference

This message is used to set the desired travel speed. More...

#include <settravelspeed.h>

Inheritance diagram for JAUS::SetTravelSpeed:

List of all members.

Classes
class	Limits
	Contains constants for limit values of data members of class. More...
Public Member Functions
	SetTravelSpeed (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	SetTravelSpeed (const SetTravelSpeed &message)
	Copy constructor.
	~SetTravelSpeed ()
	Destructor.
bool	SetSpeed (const double value)
	Sets the speed and updates the presence vector for the message.
double	GetSpeed () const
virtual bool	IsCommand () const
virtual int	WriteMessageBody (Packet &packet) const
	Writes message payload to the packet.
virtual int	ReadMessageBody (const Packet &packet)
	Reads message payload from the packet.
virtual Message *	Clone () const
virtual UInt	GetPresenceVector () const
virtual UInt	GetPresenceVectorSize () const
virtual UInt	GetPresenceVectorMask () const
virtual UShort	GetMessageCodeOfResponse () const
virtual std::string	GetMessageName () const
virtual void	ClearMessageBody ()
	Clears message payload data.
virtual void	PrintMessageBody () const
	Prints data to console.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
SetTravelSpeed &	operator= (const SetTravelSpeed &message)
	Sets equal to.
Protected Attributes
double	mSpeed
	Speed in m/s [0, 327.67].

---

Detailed Description

This message is used to set the desired travel speed.

Definition at line 54 of file settravelspeed.h.

---

Constructor & Destructor Documentation

SetTravelSpeed::SetTravelSpeed	(	const Address &	dest = Address(),
		const Address &	src = Address()
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 59 of file settravelspeed.cpp.

SetTravelSpeed::SetTravelSpeed

(

const SetTravelSpeed &

message )

Copy constructor.

Definition at line 70 of file settravelspeed.cpp.

SetTravelSpeed::~SetTravelSpeed

(

)

Destructor.

Definition at line 81 of file settravelspeed.cpp.

---

Member Function Documentation

void SetTravelSpeed::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 155 of file settravelspeed.cpp.

virtual Message* JAUS::SetTravelSpeed::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file settravelspeed.h.

virtual UShort JAUS::SetTravelSpeed::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file settravelspeed.h.

virtual std::string JAUS::SetTravelSpeed::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file settravelspeed.h.

virtual UInt JAUS::SetTravelSpeed::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file settravelspeed.h.

virtual UInt JAUS::SetTravelSpeed::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file settravelspeed.h.

virtual UInt JAUS::SetTravelSpeed::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file settravelspeed.h.

double JAUS::SetTravelSpeed::GetSpeed

(

)

const [inline]

Definition at line 73 of file settravelspeed.h.

virtual bool JAUS::SetTravelSpeed::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file settravelspeed.h.

virtual bool JAUS::SetTravelSpeed::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file settravelspeed.h.

SetTravelSpeed & SetTravelSpeed::operator=

(

const SetTravelSpeed &

message )

Sets equal to.

Definition at line 208 of file settravelspeed.cpp.

void SetTravelSpeed::PrintMessageBody

(

)

const [virtual]

Prints data to console.

Reimplemented from JAUS::Message.

Definition at line 166 of file settravelspeed.cpp.

int SetTravelSpeed::ReadMessageBody

(

const Packet &

packet )

[virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:

[in]

packet

Packet containing message payload data to read.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 139 of file settravelspeed.cpp.

int SetTravelSpeed::RunTestCase

(

)

const [virtual]

Runs a test case to validate the message class.

Returns:

1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 179 of file settravelspeed.cpp.

bool SetTravelSpeed::SetSpeed

(

const double

value )

Sets the speed and updates the presence vector for the message.

Parameters:

[in]

value

Desired speed in meters per second [0, 327.67].

Returns:

True on success, otherwise false.

Definition at line 95 of file settravelspeed.cpp.

int SetTravelSpeed::WriteMessageBody

(

Packet &

packet )

const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:

[out]

packet

Packet to write payload to.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 117 of file settravelspeed.cpp.

---

Member Data Documentation

double JAUS::SetTravelSpeed::mSpeed [protected]

Speed in m/s [0, 327.67].

Definition at line 89 of file settravelspeed.h.

---

The documentation for this class was generated from the following files:

• jaus++/2.0/include/jaus/mobility/drivers/settravelspeed.h
• jaus++/2.0/src/jaus/mobility/drivers/settravelspeed.cpp