DtIfAggregateAs Class Reference

Total: 32 bytes. More...

Inheritance diagram for DtIfAggregateAs:

List of all members.

Public Member Functions
	DtIfAggregateAs ()
	default constructor
virtual	~DtIfAggregateAs ()
	destructor
	DtIfAggregateAs (const DtIfAggregateAs &orig)
	copy constructor
DtIfAggregateAs &	operator= (const DtIfAggregateAs &orig)
	assignment operator
virtual int	type () const
	Returns the type of Interface Content; DtRemoveEntityMessageName.
virtual DtSimInterfaceContent *	clone () const
virtual DtForceType	forceType () const
	Force type of aggregate to create. See VrLink DtForceType for details.
virtual void	setForceType (DtForceType force)
virtual const DtEntityType &	entityType () const
	Entity type of aggregate to create. See VrLink DtEntityType for details.
virtual void	setEntityType (const DtEntityType &type)
virtual void	setPosition (const DtVector &position)
	Set/get local (database) position of aggregate (in meters).
virtual const DtVector &	position () const
virtual DtReal	heading () const
	Set/get heading of aggregate (0 is north, clockwise, in radians).
virtual void	setHeading (DtReal heading)
virtual unsigned long	requestId () const
	Request Id of aggregate to create.
virtual void	setRequestId (unsigned long id)
virtual void	addSubordinate (const DtString &name)
	Adds a subordinate entity to the aggregate, given its echelon ID name.
virtual DtList *	subordinates ()
	Gets the list of subordinate entities.
virtual DtAggregateState	initialAggregateState () const
	Set/get the initial aggregate state when creating an aggregate.
virtual void	setInitialAggregateState (DtAggregateState aggregateState)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Protected Attributes
DtForceType	myForceType
DtEntityType	myEntityType
DtVector	myPosition
DtReal	myHeading
DtList	myEntitiesToAggregate
unsigned long	myRequestId
DtU8	myInitialAggregateState

---

Detailed Description

Total: 32 bytes.

class DtIfAggregateAs:

Instances of DtIfAggregateAs are the content for messages sent to the back end, instructing it to aggregate a given set of entities into a pseudo-aggregate of a given echelon level.

Content-Type: DtAggregateAsMessageType

Parameters: forceType - Force type of aggregate to create (from disEnums.h).

entityType - Entity type of aggregate to create.

subordinates - A DtList of echelon ID name strings (DtString*) of subordinate entities.

---

Constructor & Destructor Documentation

DtIfAggregateAs::DtIfAggregateAs

(

)

default constructor

virtual DtIfAggregateAs::~DtIfAggregateAs

(

)

[virtual]

destructor

DtIfAggregateAs::DtIfAggregateAs

(

const DtIfAggregateAs &

orig

)

copy constructor

---

Member Function Documentation

DtIfAggregateAs& DtIfAggregateAs::operator=

(

const DtIfAggregateAs &

orig

)

assignment operator

virtual int DtIfAggregateAs::type

(

)

const [virtual]

Returns the type of Interface Content; DtRemoveEntityMessageName.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfAggregateAs::clone

(

)

const [virtual]

Implements DtSimInterfaceContent.

virtual DtForceType DtIfAggregateAs::forceType

(

)

const [virtual]

Force type of aggregate to create. See VrLink DtForceType for details.

virtual void DtIfAggregateAs::setForceType

(

DtForceType

force

)

[virtual]

virtual const DtEntityType& DtIfAggregateAs::entityType

(

)

const [virtual]

Entity type of aggregate to create. See VrLink DtEntityType for details.

virtual void DtIfAggregateAs::setEntityType

(

const DtEntityType &

type

)

[virtual]

virtual void DtIfAggregateAs::setPosition

(

const DtVector &

position

)

[virtual]

Set/get local (database) position of aggregate (in meters).

virtual const DtVector& DtIfAggregateAs::position

(

)

const [virtual]

virtual DtReal DtIfAggregateAs::heading

(

)

const [virtual]

Set/get heading of aggregate (0 is north, clockwise, in radians).

virtual void DtIfAggregateAs::setHeading

(

DtReal

heading

)

[virtual]

virtual unsigned long DtIfAggregateAs::requestId

(

)

const [virtual]

Request Id of aggregate to create.

This ID can be used to check whether the request has been carried out.

virtual void DtIfAggregateAs::setRequestId

(

unsigned long

id

)

[virtual]

virtual void DtIfAggregateAs::addSubordinate

(

const DtString &

name

)

[virtual]

Adds a subordinate entity to the aggregate, given its echelon ID name.

virtual DtList* DtIfAggregateAs::subordinates

(

)

[virtual]

Gets the list of subordinate entities.

List is a list of echelon ID name strings (DtString*).

virtual DtAggregateState DtIfAggregateAs::initialAggregateState

(

)

const [virtual]

Set/get the initial aggregate state when creating an aggregate.

Not used for non-aggregate objects. Default is DtDisaggregated.

virtual void DtIfAggregateAs::setInitialAggregateState

(

DtAggregateState

aggregateState

)

[virtual]

virtual int DtIfAggregateAs::netRepSize

(

)

const [virtual]

Reimplemented from DtSimInterfaceContent.

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

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfAggregateAs::setToNet

(

)

[virtual]

Reimplemented from DtSimInterfaceContent.

virtual void DtIfAggregateAs::printDataToString

(

DtString &

str

)

[virtual]

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfAggregateAs::creator

(

)

[static]

---

Member Data Documentation

DtForceType DtIfAggregateAs::myForceType [protected]

DtEntityType DtIfAggregateAs::myEntityType [protected]

DtVector DtIfAggregateAs::myPosition [protected]

DtReal DtIfAggregateAs::myHeading [protected]

DtList DtIfAggregateAs::myEntitiesToAggregate [protected]

unsigned long DtIfAggregateAs::myRequestId [protected]

DtU8 DtIfAggregateAs::myInitialAggregateState [protected]

---

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

• include/vrfmsgs/ifAggregateAs.h