DtSetFormationRequest Class Reference

File: setFrmation.h. More...

Inheritance diagram for DtSetFormationRequest:

List of all members.

Public Member Functions
	DtSetFormationRequest ()
	default constructor
	DtSetFormationRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetFormationRequest (const DtString &writeName, const DtSetFormationRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetFormationRequest &	operator= (const DtSetFormationRequest &orig)
	assignment operator
virtual	~DtSetFormationRequest ()
virtual int	type () const
	Returns DtSetFormationRequestType.
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 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.
virtual DtString	formationName () const
	The name of the formation to be used.
virtual void	setFormationName (const DtString &name)
	The name of the formation to be used.
Static Public Member Functions
static DtSetDataRequest *	creator ()
Protected Attributes
DtRwString	myFormationName

---

Detailed Description

File: setFrmation.h.

Class: DtSetFormationRequest DtSetFormationRequest is used to set the formation 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: DtSetFormationRequestType

parameters: formation - A character string representing a formation type. These types are defined in formTypes.h. apply to subaggregates - A Boolean flag that indicates whether the formation should be applied to any subaggregates.

---

Constructor & Destructor Documentation

DtSetFormationRequest::DtSetFormationRequest

(

)

default constructor

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

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

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

copy constructor

virtual DtSetFormationRequest::~DtSetFormationRequest

(

)

[virtual]

---

Member Function Documentation

const DtSetFormationRequest& DtSetFormationRequest::operator=

(

const DtSetFormationRequest &

orig

)

assignment operator

virtual int DtSetFormationRequest::type

(

)

const [virtual]

Returns DtSetFormationRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetFormationRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual DtString DtSetFormationRequest::formationName

(

)

const [virtual]

The name of the formation to be used.

This must match a formation that is named in the formation table of the receiving entity in order to work.

virtual void DtSetFormationRequest::setFormationName

(

const DtString &

name

)

[virtual]

The name of the formation to be used.

This must match a formation that is named in the formation table of the receiving entity in order to work.

virtual int DtSetFormationRequest::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetFormationRequest::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

virtual void DtSetFormationRequest::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* DtSetFormationRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtSetFormationRequest::myFormationName [protected]

---

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

• include/vrftasks/setFrmation.h