DtSetConvoyFollowTarget Class Reference

Set data request for switching out one system for another for the entity. More...

Inheritance diagram for DtSetConvoyFollowTarget:

List of all members.

Public Member Functions
	DtSetConvoyFollowTarget ()
	default constructor
	DtSetConvoyFollowTarget (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetConvoyFollowTarget (const DtString &writeName, const DtSetConvoyFollowTarget &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetConvoyFollowTarget &	operator= (const DtSetConvoyFollowTarget &orig)
	assignment operator
virtual	~DtSetConvoyFollowTarget ()
virtual int	type () const
	Returns DtSetConvoyFollowTargetType.
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of the request.
virtual DtString	stringRep () const
	Get a readable string representation of this setDataRequest.
virtual const DtString &	convoyTargetName () const
	The name of the entity to follow in the convoy.
virtual void	setConvoyTargetName (const DtString &name)
	The name of the entity to follow in the convoy.
DtRwString	myFollowTargetName
	The distance at which to follow.
DtRwReal	myFollowDistance
	The distance at which to follow.
DtRwBoolean	myUseCatchUpSpeed
	The distance at which to follow.
virtual const double	distanceToFollow () const
	The distance at which to follow.
virtual void	setDistanceToFollow (const double dist)
	The distance at which to follow.
virtual const bool	useCatchUpSpeed () const
	The distance at which to follow.
virtual void	setUseCatchUpSpeed (const bool useCatchUpSpeed)
	The distance at which to follow.
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
static DtSetDataRequest *	creator ()
	The distance at which to follow.

---

Detailed Description

Set data request for switching out one system for another for the entity.

DtSetConvoyFollowTarget is used to set the entity to follow in the convoy and the offset distance to follow at.

---

Constructor & Destructor Documentation

DtSetConvoyFollowTarget::DtSetConvoyFollowTarget

(

)

default constructor

DtSetConvoyFollowTarget::DtSetConvoyFollowTarget	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetConvoyFollowTarget::DtSetConvoyFollowTarget	(	const DtString &	writeName,
		const DtSetConvoyFollowTarget &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetConvoyFollowTarget::~DtSetConvoyFollowTarget

(

)

[virtual]

---

Member Function Documentation

const DtSetConvoyFollowTarget& DtSetConvoyFollowTarget::operator=

(

const DtSetConvoyFollowTarget &

orig

)

assignment operator

virtual int DtSetConvoyFollowTarget::type

(

)

const [virtual]

Returns DtSetConvoyFollowTargetType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetConvoyFollowTarget::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetConvoyFollowTarget::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtString& DtSetConvoyFollowTarget::convoyTargetName

(

)

const [virtual]

The name of the entity to follow in the convoy.

virtual void DtSetConvoyFollowTarget::setConvoyTargetName

(

const DtString &

name

)

[virtual]

The name of the entity to follow in the convoy.

virtual const double DtSetConvoyFollowTarget::distanceToFollow

(

)

const [virtual]

The distance at which to follow.

virtual void DtSetConvoyFollowTarget::setDistanceToFollow

(

const double

dist

)

[virtual]

The distance at which to follow.

virtual const bool DtSetConvoyFollowTarget::useCatchUpSpeed

(

)

const [virtual]

The distance at which to follow.

virtual void DtSetConvoyFollowTarget::setUseCatchUpSpeed

(

const bool

useCatchUpSpeed

)

[virtual]

The distance at which to follow.

virtual int DtSetConvoyFollowTarget::netRepSize

(

)

const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetConvoyFollowTarget::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetConvoyFollowTarget::setToNet

(

)

[virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetConvoyFollowTarget::creator

(

)

[static]

The distance at which to follow.

---

Member Data Documentation

DtRwString DtSetConvoyFollowTarget::myFollowTargetName [protected]

The distance at which to follow.

DtRwReal DtSetConvoyFollowTarget::myFollowDistance [protected]

The distance at which to follow.

DtRwBoolean DtSetConvoyFollowTarget::myUseCatchUpSpeed [protected]

The distance at which to follow.

---

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

• include/vrftasks/setConvoyFollowTarget.h