DtIfAggregateAs Class Reference

This is the FIXED length portion of a DtIfAggregateAs message content when placed on the network. More...

Inheritance diagram for DtIfAggregateAs:

Public Member Functions
	DtIfAggregateAs ()
	default constructor More...
virtual	~DtIfAggregateAs ()
	destructor More...
	DtIfAggregateAs (const DtIfAggregateAs &orig)
	copy constructor More...
DtIfAggregateAs &	operator= (const DtIfAggregateAs &orig)
	assignment operator More...
virtual int	type () const
	Returns the type of Interface Content; DtRemoveEntityMessageName. More...
virtual DtSimInterfaceContent *	clone () const
virtual DtForceType	forceType () const
	Force type of aggregate to create. See VrLink DtForceType for details. More...
virtual void	setForceType (DtForceType force)
virtual const DtEntityType &	entityType () const
	Entity type of aggregate to create. See VrLink DtEntityType for details. More...
virtual void	setEntityType (const DtEntityType &type)
virtual void	setPosition (const DtVector &position)
	Set/get local (database) position of aggregate (in meters). More...
virtual const DtVector &	position () const
virtual DtReal	heading () const
	Set/get heading of aggregate (0 is north, clockwise, in radians). More...
virtual void	setHeading (DtReal heading)
virtual unsigned long	requestId () const
	Request Id of aggregate to create. More...
virtual void	setRequestId (unsigned long id)
virtual void	addSubordinate (const DtUUID &name)
	Adds a subordinate entity to the aggregate, given its echelon ID name. More...
virtual void	setUUID (const DtUUID &)
	If need be, the starting UUID to give to the aggregate when creating it. More...
virtual const DtUUID &	uuid () const
virtual const std::vector < DtUUID > &	subordinates () const
	Gets the list of subordinate entities. List is a list of uuids. More...
virtual std::vector< DtUUID > &	subordinates ()
virtual DtAggregateState	initialAggregateState () const
	Set/get the initial aggregate state when creating an aggregate. More...
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)
virtual void	setAddToOrbat (bool)
	Whether or not this aggregate (and potentially its subordiantes) should be added to the orbat. More...
virtual bool	addToOrbat () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtForceType	myForceType
DtEntityType	myEntityType
DtVector	myPosition
DtReal	myHeading
std::vector< DtUUID >	myEntitiesToAggregate
DtU32	myRequestId
DtU8	myInitialAggregateState
DtUUID	myUUID
bool	myAddToOrbat
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Detailed Description

This is the FIXED length portion of a DtIfAggregateAs message content when placed on the network.

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 uuids of entities to add 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 DtUUID &  name )

virtual

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

virtual void DtIfAggregateAs::setUUID ( const DtUUID &  )

virtual

If need be, the starting UUID to give to the aggregate when creating it.

virtual const DtUUID& DtIfAggregateAs::uuid ( ) const

virtual

virtual const std::vector<DtUUID>& DtIfAggregateAs::subordinates ( ) const

virtual

Gets the list of subordinate entities. List is a list of uuids.

virtual std::vector<DtUUID>& DtIfAggregateAs::subordinates ( )

virtual

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

virtual void DtIfAggregateAs::setAddToOrbat ( bool  )

virtual

Whether or not this aggregate (and potentially its subordiantes) should be added to the orbat.

if the subordaintes are in the orbat and this flag is false the aggregate will still be added to the orbat. Default is true

virtual bool DtIfAggregateAs::addToOrbat ( ) const

virtual

Member Data Documentation

DtForceType DtIfAggregateAs::myForceType

protected

DtEntityType DtIfAggregateAs::myEntityType

protected

DtVector DtIfAggregateAs::myPosition

protected

DtReal DtIfAggregateAs::myHeading

protected

std::vector<DtUUID> DtIfAggregateAs::myEntitiesToAggregate

protected

DtU32 DtIfAggregateAs::myRequestId

protected

DtU8 DtIfAggregateAs::myInitialAggregateState

protected

DtUUID DtIfAggregateAs::myUUID

protected

bool DtIfAggregateAs::myAddToOrbat

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfmsgs/ifAggregateAs.h