DtSetEngagementRulesRequest Class Reference

DtSetEngagementRulesRequest is used to set the rules of engagement for an entity. More...

Inheritance diagram for DtSetEngagementRulesRequest:

List of all members.

Public Member Functions
	DtSetEngagementRulesRequest ()
	default constructor
	DtSetEngagementRulesRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetEngagementRulesRequest (const DtString &writeName, const DtSetEngagementRulesRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetEngagementRulesRequest &	operator= (const DtSetEngagementRulesRequest &orig)
	assignment operator
virtual	~DtSetEngagementRulesRequest ()
virtual int	type () const
	Returns DtSetEngagementRulesRequestType.
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 &	engagementRules () const
	A character string representing an engagement rule.
virtual void	setEngagementRules (const DtString &rules)
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
DtRwString	myEngagementRules

---

Detailed Description

DtSetEngagementRulesRequest is used to set the rules of engagement for an entity.

It inherits read/writableness from DtSetDataRequest, and includes the rules of engagement to assume.

set-data-request-type: DtSetEngagementRulesRequestType

parameters: engagement rules - A character string representing an engagement rule. The engagement rules available in VR- Forces are "fire-at-will", "fire-when-fired-upon", and "hold- fire".

---

Constructor & Destructor Documentation

DtSetEngagementRulesRequest::DtSetEngagementRulesRequest

(

)

default constructor

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

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

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

copy constructor

virtual DtSetEngagementRulesRequest::~DtSetEngagementRulesRequest

(

)

[virtual]

---

Member Function Documentation

const DtSetEngagementRulesRequest& DtSetEngagementRulesRequest::operator=

(

const DtSetEngagementRulesRequest &

orig

)

assignment operator

virtual int DtSetEngagementRulesRequest::type

(

)

const [virtual]

Returns DtSetEngagementRulesRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetEngagementRulesRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtString& DtSetEngagementRulesRequest::engagementRules

(

)

const [virtual]

A character string representing an engagement rule.

The engagement rules available in VR-Forces are “fire-at-will”, “fire-when-fired-upon”, and “hold-fire”.

virtual void DtSetEngagementRulesRequest::setEngagementRules

(

const DtString &

rules

)

[virtual]

virtual int DtSetEngagementRulesRequest::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetEngagementRulesRequest::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetEngagementRulesRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtSetEngagementRulesRequest::myEngagementRules [protected]

---

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

• include/vrftasks/setEngRules.h