DtIfAddToOrganization Class Reference

class DtIfAddToOrganization: More...

Inheritance diagram for DtIfAddToOrganization:

Public Member Functions
	DtIfAddToOrganization ()
	default constructor
virtual	~DtIfAddToOrganization ()
	destructor
	DtIfAddToOrganization (const DtIfAddToOrganization &orig)
	copy constructor
DtIfAddToOrganization &	operator= (const DtIfAddToOrganization &orig)
	assignment operator
virtual int	type () const
	Returns the string type of message, DtAddToOrganizationType (defined in msgTypes.h).
virtual void	setObjectIdentifier (const DtEntityIdentifier &objectIdentifier)
	Set/get the object identifier (site:app:object id) of the vrf object.
virtual const DtEntityIdentifier &	objectIdentifier () const
virtual void	setNewSuperiorId (const DtEntityIdentifier &superiorId)
	Set/get the current object name of the vrf object whose position in the organization you want to modify.
virtual const DtEntityIdentifier &	newSuperiorId () const
virtual void	setSuperiorIsForce (bool isForce)
	If superiorIsForce is set to true, the newSuperiorId is disregarded, and the new superior is the force level object corresponding to the objects force type.
virtual bool	superiorIsForce () const
virtual void	setDesignator (DtInt8 pos)
	Set/get assign designator flag.
virtual DtInt8	designator () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
DtSimInterfaceContent *	clone () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtEntityIdentifier	myObjectIdentifier
DtEntityIdentifier	myNewSuperiorId
DtInt8	myDesignator
bool	mySuperiorIsForce

Detailed Description

class DtIfAddToOrganization:

Instances of DtNetIfAddToOrganization are the message content for adding an organized entity to a superior.

Content-Type: DtAddToOrganizationType

Constructor & Destructor Documentation

DtIfAddToOrganization::DtIfAddToOrganization

(

)

default constructor

virtual DtIfAddToOrganization::~DtIfAddToOrganization ( )

virtual

destructor

DtIfAddToOrganization::DtIfAddToOrganization

(

const DtIfAddToOrganization &

orig

)

copy constructor

Member Function Documentation

DtIfAddToOrganization& DtIfAddToOrganization::operator=

(

const DtIfAddToOrganization &

orig

)

assignment operator

virtual int DtIfAddToOrganization::type ( ) const

virtual

Returns the string type of message, DtAddToOrganizationType (defined in msgTypes.h).

virtual void DtIfAddToOrganization::setObjectIdentifier ( const DtEntityIdentifier &  objectIdentifier )

virtual

Set/get the object identifier (site:app:object id) of the vrf object.

Corresponds to entity identifier for individual entities, aggregate Id for aggregates, and object identifier for environmental process objects.

virtual const DtEntityIdentifier& DtIfAddToOrganization::objectIdentifier ( ) const

virtual

virtual void DtIfAddToOrganization::setNewSuperiorId ( const DtEntityIdentifier &  superiorId )

virtual

Set/get the current object name of the vrf object whose position in the organization you want to modify.

virtual const DtEntityIdentifier& DtIfAddToOrganization::newSuperiorId ( ) const

virtual

virtual void DtIfAddToOrganization::setSuperiorIsForce ( bool  isForce )

virtual

If superiorIsForce is set to true, the newSuperiorId is disregarded, and the new superior is the force level object corresponding to the objects force type.

(This is necessary because force level objects are not published, and the front end or other backends will not know the object ID to use when referencing them.)

virtual bool DtIfAddToOrganization::superiorIsForce ( ) const

virtual

virtual void DtIfAddToOrganization::setDesignator ( DtInt8  pos )

virtual

Set/get assign designator flag.

virtual DtInt8 DtIfAddToOrganization::designator ( ) const

virtual

virtual int DtIfAddToOrganization::netRepSize ( ) const

virtual

virtual bool DtIfAddToOrganization::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

virtual bool DtIfAddToOrganization::setToNet ( )

virtual

virtual void DtIfAddToOrganization::printDataToString ( DtString &  str )

virtual

DtSimInterfaceContent* DtIfAddToOrganization::clone

(

)

const

static DtSimInterfaceContent* DtIfAddToOrganization::creator ( )

static

Member Data Documentation

DtEntityIdentifier DtIfAddToOrganization::myObjectIdentifier

protected

DtEntityIdentifier DtIfAddToOrganization::myNewSuperiorId

protected

DtInt8 DtIfAddToOrganization::myDesignator

protected

bool DtIfAddToOrganization::mySuperiorIsForce

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifAddToOrg.h