VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtIfAddToOrganization Class Reference

class DtIfAddToOrganization: More...

Inheritance diagram for DtIfAddToOrganization:
Inheritance graph
[legend]

Public Member Functions

 DtIfAddToOrganization ()
 default constructor
virtual ~DtIfAddToOrganization ()
 destructor
 DtIfAddToOrganization (const DtIfAddToOrganization &orig)
 copy constructor
DtIfAddToOrganizationoperator= (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)
DtSimInterfaceContentclone () const
- Public Member Functions inherited from DtSimInterfaceContent
virtual ~DtSimInterfaceContent ()
virtual bool update (const DtSimInterfaceContent *data)
virtual char * netRep ()
virtual void setUseSessionId (bool yesNo)
virtual bool useSessionId () const

Static Public Member Functions

static DtSimInterfaceContentcreator ()
- Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContentcreateInterfaceContent (int type)
static void addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactoryfactory ()

Protected Attributes

DtEntityIdentifier myObjectIdentifier
DtEntityIdentifier myNewSuperiorId
DtInt8 myDesignator
bool mySuperiorIsForce
- Protected Attributes inherited from DtSimInterfaceContent
char * myNetRep
bool myUseSessionId

Additional Inherited Members

- Protected Member Functions inherited from DtSimInterfaceContent
 DtSimInterfaceContent ()
 DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContentoperator= (const DtSimInterfaceContent &orig)
virtual char * createNetworkBuffer ()
- Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactorymyFactory

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).

Implements DtSimInterfaceContent.

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

Reimplemented from DtSimInterfaceContent.

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

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfAddToOrganization::setToNet ( )
virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfAddToOrganization::printDataToString ( DtString str)
virtual

Reimplemented from DtSimInterfaceContent.

DtSimInterfaceContent* DtIfAddToOrganization::clone ( ) const
virtual

Implements DtSimInterfaceContent.

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:

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)