DtSetLocationRequest Class Reference

DtSetLocationRequest is used to force a location for (sometimes called teleporting) an entity. More...

Inheritance diagram for DtSetLocationRequest:

List of all members.

Public Member Functions
	DtSetLocationRequest ()
	default constructor
	DtSetLocationRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetLocationRequest (const DtString &writeName, const DtSetLocationRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetLocationRequest &	operator= (const DtSetLocationRequest &orig)
	assignment operator
virtual	~DtSetLocationRequest ()
virtual int	type () const
	Returns DtSetLocationRequestType.
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 DtVector &	location () const
	New location, specified in geocentric coordinates.
virtual void	setLocation (const DtVector &location)
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 Public Member Functions
static DtSetDataRequest *	creator ()
Protected Attributes
DtRwVector	myLocation

---

Detailed Description

DtSetLocationRequest is used to force a location for (sometimes called teleporting) an entity.

It inherits read/writableness from DtSetDataRequest, and includes the location in geocentric coordinates. Z is ignored for non-air vehicles.

set-data-request-type: DtSetLocationRequestType

parameters: location - The new location for the entity, in geocentric (meters). Ground vehicles will be clamped to the terrain surface.

---

Constructor & Destructor Documentation

DtSetLocationRequest::DtSetLocationRequest

(

)

default constructor

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

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

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

copy constructor

virtual DtSetLocationRequest::~DtSetLocationRequest

(

)

[virtual]

---

Member Function Documentation

const DtSetLocationRequest& DtSetLocationRequest::operator=

(

const DtSetLocationRequest &

orig

)

assignment operator

virtual int DtSetLocationRequest::type

(

)

const [virtual]

Returns DtSetLocationRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetLocationRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtVector& DtSetLocationRequest::location

(

)

const [virtual]

New location, specified in geocentric coordinates.

: For compatibility with pre-VRF 3.5 plans, VRF set controllers accept UTM locations in this field.

virtual void DtSetLocationRequest::setLocation

(

const DtVector &

location

)

[virtual]

virtual int DtSetLocationRequest::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetLocationRequest::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetLocationRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwVector DtSetLocationRequest::myLocation [protected]

---

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

• include/vrftasks/setLocation.h