DtAggregateOrganizationController Class Reference

DtPseudoAggregateOrganizationController is the controller component in pseudo-aggregates responsible for maintaining the command organization within its group of subordinate entities. More...

Inheritance diagram for DtAggregateOrganizationController:

Public Member Functions
	DtAggregateOrganizationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtAggregateOrganizationController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Updates the echelon organization as necessary, such as in the event of an entity getting destroyed or removed.
virtual void	setRadio (DtSimBaseRadio *radio)
	Override to add callback for setReorganize messages.
virtual void	onSetReorganize (DtSimMessage *msg)
	Handler for setReorganize messages.
virtual void	registerWithOrgManager ()
virtual void	unregisterWithOrgManager ()
Public Member Functions inherited from DtOrganizationController
	DtOrganizationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
	DtOrganizationController (const DtOrganizationController &orig)
	copy constructor
const DtOrganizationController &	operator= (const DtOrganizationController &orig)
	assignment operator
virtual	~DtOrganizationController ()
	destructor
virtual bool	init ()
	Calls setRadio()
virtual bool	generateEchelonId (int designator)
	Generates an echelon id based on the provided designator, the local entity opd entry, and the current state of the organization hierarchy, and assigns the echelon id to the entity.
virtual void	processSetDesignator (DtSimMessage *msg)
	Calls generateEchelonId with the designator provided in the message.
virtual bool	tickWhileDestroyed () const
	Organization-related activities should happen regardless of destroyed status.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
	The radio this component is listening to.
virtual void	taskNotify (const DtSimTask &task)
	This is used by the entity to notify all controllers that a new task has been received.
virtual void	clearTask ()
	Called when you want to clear out this component's task state.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	subordinatesChangedCallback (DtEntityIdentifier entId, void *usr)
static void	reorganizeCallback (DtSimMessage *msg, void *usrData)
	Callback for handling reorganize messages.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Static Public Member Functions inherited from DtOrganizationController
static void	setDesignatorCallback (DtSimMessage *msg, void *usrData)

Protected Member Functions
virtual void	processSubordinatesChangedCallback (DtEntityIdentifier entId)
virtual void	initiateAllSubordinates ()
	Checks the internal subordinate list against the subordinate manager for any new or removed subordinates.
virtual void	initiateNewSubordinate (DtVrfObject *subordinate, int designator)
	Called by checkSubordinates.
virtual void	setCommandNetRadioChannel ()
	Sets the command net radio channel for this entity's radio to a unique number based on the entity identifier.
virtual int	nextAvaliableDesignator ()
	Returns the next avaliable designator to be used.
virtual void	reorganize ()
	Reorganizes the aggregate members, moving destroyed or independly tasked entities to the bottom of the list (lowest rank).
virtual void	sendSetDesignator (int designator, const DtString &objectName)
	Transmitts a setDesignator to the specified object with the specified designator.
virtual bool	reorganizeNeeded ()
	Returns true if reorganization is needed (invalid entities need to be reassigned to least significant roles).

Protected Attributes
bool	myRegisteredWithOrgManager
	Working list of subordinates (DtVrfObject*'s).
DtCommandChannelRadio *	myCommandRadio
Protected Attributes inherited from DtOrganizationController
int	myRequestedDesignator
	Used to store the requested designator if the echelon ID is not set immediatly.
Protected Attributes inherited from DtControllerComponent
DtSimBaseRadio *	myRadio
	Controller components can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtAggregateOrganizationController ()
	Not implemented.
	DtAggregateOrganizationController (const DtAggregateOrganizationController &orig)
	Not implemented.
DtAggregateOrganizationController &	operator= (const DtAggregateOrganizationController &orig)
	Not implemented.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtPseudoAggregateOrganizationController is the controller component in pseudo-aggregates responsible for maintaining the command organization within its group of subordinate entities.

Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

DtAggregateOrganizationController::DtAggregateOrganizationController ( )

private

Not implemented.

DtAggregateOrganizationController::DtAggregateOrganizationController ( const DtAggregateOrganizationController &  orig )

private

Not implemented.

DtAggregateOrganizationController::DtAggregateOrganizationController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtAggregateOrganizationController::~DtAggregateOrganizationController ( )

virtual

destructor

Member Function Documentation

DtAggregateOrganizationController& DtAggregateOrganizationController::operator= ( const DtAggregateOrganizationController &  orig )

private

Not implemented.

virtual DtString DtAggregateOrganizationController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns

DtPseudoAggregateOrganizationControllerType

Reimplemented from DtOrganizationController.

Reimplemented in DtTopLevelOrganizationController.

virtual void DtAggregateOrganizationController::tick ( )

virtual

Updates the echelon organization as necessary, such as in the event of an entity getting destroyed or removed.

Will only perform reorganization (re-assignment of echelon IDs) if enabled in the entity manager.

Reimplemented from DtOrganizationController.

Reimplemented in DtTopLevelOrganizationController.

virtual void DtAggregateOrganizationController::setRadio ( DtSimBaseRadio *  radio )

virtual

Override to add callback for setReorganize messages.

Calls setCommandNetRadioChannel to initialize the radio channel.

Reimplemented from DtOrganizationController.

virtual void DtAggregateOrganizationController::onSetReorganize ( DtSimMessage *  msg )

virtual

Handler for setReorganize messages.

Reorganizes the unit if necessary (one or more member entities have been destroyed, missing, or independently tasked).

virtual void DtAggregateOrganizationController::registerWithOrgManager ( )

virtual

virtual void DtAggregateOrganizationController::unregisterWithOrgManager ( )

virtual

static void DtAggregateOrganizationController::subordinatesChangedCallback ( DtEntityIdentifier  entId, void *  usr  )

static

static void DtAggregateOrganizationController::reorganizeCallback ( DtSimMessage *  msg, void *  usrData  )

static

Callback for handling reorganize messages.

static DtSimComponent* DtAggregateOrganizationController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

Reimplemented from DtOrganizationController.

Reimplemented in DtTopLevelOrganizationController.

virtual void DtAggregateOrganizationController::processSubordinatesChangedCallback ( DtEntityIdentifier  entId )

protectedvirtual

virtual void DtAggregateOrganizationController::initiateAllSubordinates ( )

protectedvirtual

Checks the internal subordinate list against the subordinate manager for any new or removed subordinates.

Sends the set designator message to every subordinate.

virtual void DtAggregateOrganizationController::initiateNewSubordinate ( DtVrfObject *  subordinate, int  designator  )

protectedvirtual

Called by checkSubordinates.

Sends a setChannel message and sends a message informing the subordinate of it's new designator.

virtual void DtAggregateOrganizationController::setCommandNetRadioChannel ( )

protectedvirtual

Sets the command net radio channel for this entity's radio to a unique number based on the entity identifier.

Reimplemented in DtTopLevelOrganizationController.

virtual int DtAggregateOrganizationController::nextAvaliableDesignator ( )

protectedvirtual

Returns the next avaliable designator to be used.

Reimplemented in DtTopLevelOrganizationController.

virtual void DtAggregateOrganizationController::reorganize ( )

protectedvirtual

Reorganizes the aggregate members, moving destroyed or independly tasked entities to the bottom of the list (lowest rank).

Reassigns the echelon ID designators, starting with 1, and with no gaps.

Reimplemented in DtTopLevelOrganizationController.

virtual void DtAggregateOrganizationController::sendSetDesignator ( int  designator, const DtString &  objectName  )

protectedvirtual

Transmitts a setDesignator to the specified object with the specified designator.

virtual bool DtAggregateOrganizationController::reorganizeNeeded ( )

protectedvirtual

Returns true if reorganization is needed (invalid entities need to be reassigned to least significant roles).

Reimplemented in DtTopLevelOrganizationController.

Member Data Documentation

bool DtAggregateOrganizationController::myRegisteredWithOrgManager

protected

Working list of subordinates (DtVrfObject*'s).

DtList mySubordinateEntityList;

DtCommandChannelRadio* DtAggregateOrganizationController::myCommandRadio

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/aggregateOrganizationController.h