VR-Forces 4.0.4 Class Documentation
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
DtOrganizationChangeSet Class Reference

DtOrganizationChangeSet. More...

List of all members.

Classes

struct  DtSetSubordinateInformation
struct  DtSetSubordinateToForceInformation

Public Types

typedef std::list
< DtSetSubordinateInformation
DtSetSuperiorList
typedef std::list
< DtSetSubordinateToForceInformation
DtSetSuperiorToForceList

Public Member Functions

 DtOrganizationChangeSet ()
virtual ~DtOrganizationChangeSet ()
 DtOrganizationChangeSet (const DtOrganizationChangeSet &orig)
DtOrganizationChangeSetoperator= (const DtOrganizationChangeSet &orig)
virtual void addSetSuperior (const DtString &subordinateName, const DtString &superiorName, int designator=0)
 Adds a "Set Superior" command to the change set.
virtual void addSetSuperiorToForce (const DtString &subordinateName, int designator=0)
 Adds a "Set Superior To Force" command to the change set.
virtual const DtSetSuperiorListsetSuperiorCommands () const
virtual const
DtSetSuperiorToForceList
setSuperiorToForceCommands () const
virtual void clear ()
 Empties contents of change set.

Protected Member Functions

virtual void removeItemsWithSubordiate (const DtString &subordinateName)
 Removes any existing items from the lists that have the specified subordinate.

Protected Attributes

DtSetSuperiorList mySetSuperiorList
 List of all the Set Superior commands in the set.
DtSetSuperiorToForceList mySetSuperiorToForceList
 List of all the Set Superior To Force commands in the set.

Detailed Description

DtOrganizationChangeSet.

Holds a set of changes to the organization hierarchy. This set can be passed to the DtOrganizationManager to initiate the enclosed changes.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

DtOrganizationChangeSet& DtOrganizationChangeSet::operator= ( const DtOrganizationChangeSet orig)
virtual void DtOrganizationChangeSet::addSetSuperior ( const DtString subordinateName,
const DtString superiorName,
int  designator = 0 
) [virtual]

Adds a "Set Superior" command to the change set.

This is a command that will place the specified subordinate directly under the specified superior in the organization hierarchy.

Note:
This call will also remove any existing commands in the change set that assign the specified subordinate to any other superior.
virtual void DtOrganizationChangeSet::addSetSuperiorToForce ( const DtString subordinateName,
int  designator = 0 
) [virtual]

Adds a "Set Superior To Force" command to the change set.

This command causes the specified subordinate to become a direct subordinate of the force level aggregate of that entity's force. i.e. This entity will become a top level entity.

Note:
This call will also remove any existing commands in the change set that assign the specified subordinate to any other superior.
virtual void DtOrganizationChangeSet::clear ( ) [virtual]

Empties contents of change set.

virtual void DtOrganizationChangeSet::removeItemsWithSubordiate ( const DtString subordinateName) [protected, virtual]

Removes any existing items from the lists that have the specified subordinate.

This is to prevent a single change set from having contradictory changes.


Member Data Documentation

List of all the Set Superior commands in the set.

List of all the Set Superior To Force commands in the set.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)