DtSnapIntoFormationRequest Class Reference

File: snapIntoFormationRequest.h. More...

Inheritance diagram for DtSnapIntoFormationRequest:

List of all members.

Public Member Functions
	DtSnapIntoFormationRequest ()
	default constructor
	DtSnapIntoFormationRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSnapIntoFormationRequest (const DtString &writeName, const DtSnapIntoFormationRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSnapIntoFormationRequest &	operator= (const DtSnapIntoFormationRequest &orig)
	assignment operator
virtual	~DtSnapIntoFormationRequest ()
virtual int	type () const
	Returns DtSnapIntoFormationRequestType.
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
	location (in geocentric coordinates) at which aggregate should get into formation
virtual void	setLocation (const DtVector &point)
virtual double	heading () const
	heading (in radians) at which aggregate should orient formation
virtual void	setHeading (double heading)
virtual DtString	formationName () const
virtual void	setFormationName (const DtString &formation)
virtual void	setApplyHeading (bool applyHeading)
	Indicate whether or not to set heading in subordinates.
virtual bool	applyHeading () const
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.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Overridden to read in the old formation enumeration and convert it to a formation name.
Static Public Member Functions
static DtSetDataRequest *	creator ()
Protected Attributes
DtRwVector	myLocation
DtRwReal	myHeading
DtRwString	myFormationName
DtRwBoolean	myApplyHeading

---

Detailed Description

File: snapIntoFormationRequest.h.

Class: DtSnapIntoFormationRequest DtSnapIntoFormationRequest is used to set the formation type for an (aggregate) entity. It inherits read/writableness from DtSetDataRequest. The name of the formation type is specified in the request. All aggregates set the formation type as a parameter. Pseudo-aggregates establish rules for moving in formation (who follows whom, and at what offset) among its member entities. It uses the forma- tion type to look up the formation details in the object parameters data- base.

set-data-request-type: DtSnapIntoFormationRequestType

parameters: formation - A character string representing a formation type. These types are defined in formTypes.h.

---

Constructor & Destructor Documentation

DtSnapIntoFormationRequest::DtSnapIntoFormationRequest

(

)

default constructor

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

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

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

copy constructor

virtual DtSnapIntoFormationRequest::~DtSnapIntoFormationRequest

(

)

[virtual]

---

Member Function Documentation

const DtSnapIntoFormationRequest& DtSnapIntoFormationRequest::operator=

(

const DtSnapIntoFormationRequest &

orig

)

assignment operator

virtual int DtSnapIntoFormationRequest::type

(

)

const [virtual]

Returns DtSnapIntoFormationRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSnapIntoFormationRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtVector& DtSnapIntoFormationRequest::location

(

)

const [virtual]

location (in geocentric coordinates) at which aggregate should get into formation

virtual void DtSnapIntoFormationRequest::setLocation

(

const DtVector &

point

)

[virtual]

virtual double DtSnapIntoFormationRequest::heading

(

)

const [virtual]

heading (in radians) at which aggregate should orient formation

virtual void DtSnapIntoFormationRequest::setHeading

(

double

heading

)

[virtual]

virtual DtString DtSnapIntoFormationRequest::formationName

(

)

const [virtual]

virtual void DtSnapIntoFormationRequest::setFormationName

(

const DtString &

formation

)

[virtual]

virtual void DtSnapIntoFormationRequest::setApplyHeading

(

bool

applyHeading

)

[virtual]

Indicate whether or not to set heading in subordinates.

virtual bool DtSnapIntoFormationRequest::applyHeading

(

)

const [virtual]

virtual int DtSnapIntoFormationRequest::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSnapIntoFormationRequest::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

virtual void DtSnapIntoFormationRequest::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath = DtFilename::nullFilename(),
		const DtVariableBindingsList &	variableBindings = nullVariableReference()
	)		[virtual]

Overridden to read in the old formation enumeration and convert it to a formation name.

static DtSetDataRequest* DtSnapIntoFormationRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwVector DtSnapIntoFormationRequest::myLocation [protected]

DtRwReal DtSnapIntoFormationRequest::myHeading [protected]

DtRwString DtSnapIntoFormationRequest::myFormationName [protected]

DtRwBoolean DtSnapIntoFormationRequest::myApplyHeading [protected]

---

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

• include/vrftasks/snapIntoFormationRequest.h