This class maintains a hierarchy of the existing organized entities for a simulation based on the contents of Aggregate State PDUs. More...

Inheritance diagram for DtOrganizationView:

[legend]

Public Types
typedef boost::unordered_map < DtUUID, DtOrganizationManagerNode * >	UUIDMap

typedef boost::unordered_map < int, DtOrganizationManagerNode * >	ForceMap

Public Member Functions
	DtOrganizationView (DtVrfObjectManager *objMgr)
	Constructor. More...

virtual	~DtOrganizationView ()
	Destructor. More...

virtual bool	init ()

virtual DtOrgViewManagedObjectListConstPtr	getList (const DtUUID &aggregate, const DtVrfObjectPredicate &predicate=DtVrfObjectPredicate::nullPredicate(), bool reevaluateFlag=false, DtTime evaluationPeriod=0.) const
	Request a filtered list of subordinates for a given aggregate, based on user-supplied criteria. More...

virtual DtOrgViewManagedObjectListConstPtr	nullList () const

virtual void	objectUUIDChanged (const DtUUID &oldUUID, const DtUUID &newUUID)
	Notification that UUID has changed for the given UUID to the new UUID. More...


virtual DtOrganizationManagerNode *	lookupNode (const DtUUID &) const
	Methods for inspecting the hierarchy. More...

virtual DtOrganizationManagerNode *	lookupNodeByUUID (const DtUUID &) const
	Looks up node by UUID. Call if you know this is a valid vrfUUID, else call lookupNode. More...

virtual bool	removeNode (const DtUUID &)
	Removes the node represented by the UUID. More...

virtual bool	isSubordinateOfTopLevel (const DtUUID &) const

virtual const DtUUID &	superior (const DtUUID &) const

virtual DtSharedVrfObjectReference	superiorVrfObject (const DtUUID &) const

virtual bool	isSubordinateOf (const DtUUID &subordinate, const DtUUID &superior) const


virtual DtOrganizationManagerNode *	addEntity (const DtVrfObject *vrfObject)
	Functions for manipulating the hierarchy. More...

virtual void	removeEntity (const DtVrfObject *vrfObject)
	Removes the node for this entity from the hierarchy. More...

virtual void	updateAggregate (const DtVrfObject *vrfObject)
	Updates the connections to the node corresponding to this aggregate. More...

virtual void	updateEntity (const DtVrfObject *vrfObject)
	Updates the connections to the node corresponding to this entity. More...


virtual void	addNodeAddedCallback (DtOrgViewCallbackList::DtCallbackFunctionType fcn, void *userData) const
	Callback for notification when a child is added to the list of child nodes. More...

virtual void	removeNodeAddedCallback (DtOrgViewCallbackList::DtCallbackFunctionType fcn, void *userData) const


virtual void	addNodeRemovedCallback (DtOrgViewCallbackList::DtCallbackFunctionType fcn, void *userData) const
	Callback for notification when a child is to be removed from the list of child nodes. More...

virtual void	removeNodeRemovedCallback (DtOrgViewCallbackList::DtCallbackFunctionType fcn, void *userData) const


virtual void	addNodeAboutToBeRemovedCallback (DtOrgViewCallbackList::DtCallbackFunctionType fcn, void *userData) const
	Callback for notification when a child is about to be removed from the list of child nodes. More...

virtual void	removeNodeAboutToBeRemovedCallback (DtOrgViewCallbackList::DtCallbackFunctionType fcn, void *userData) const

Static Public Member Functions
static void	vrfObjectAddedCallback (const DtVrfObject vrfObject, void usr)

static void	vrfObjectAboutToBeRemovedCallback (const DtVrfObject vrfObject, void usr)

Protected Member Functions
	DtOrganizationView (const DtOrganizationView &orig)
	Copy constructor not implemented. More...

DtOrganizationView &	operator= (const DtOrganizationView &orig)
	Assignment operator not implemented. More...

virtual DtOrganizationManagerNode *	createOrganizationManagerNode () const
	Creates a new node to put into the hierarchy. More...

virtual void	processVrfObjectAdded (const DtVrfObject *vrfObject)

virtual void	processVrfObjectAboutToBeRemoved (const DtVrfObject *vrfObject)
	Looks up vrfObject's superior. More...

virtual bool	shouldBeAdded (const DtVrfObject *vrfObject) const

virtual void	findAndConnectNodeParent (DtOrganizationManagerNode *node)
	Searches the existing hierarchy for an aggregate which claims this node, and connects it as a child. More...

virtual void	disconnectNodeParent (DtOrganizationManagerNode *node)
	Removes the specified node from the child list of it's current parent, and sets it parent to NULL. More...

virtual void	findAndConnectNodeChildren (DtOrganizationManagerNode *node)
	Looks up this vrfObject, and searches the existing hierarchy for any nodes specified in the subordinate manger of this object and connects them to this node as children. More...

virtual void	disconnectNodeChildren (DtOrganizationManagerNode *node)
	Disconnects all the children from this node. More...

virtual void	connectNodeToTopLevel (DtOrganizationManagerNode *node, bool allowCreation=true)
	Makes this node a child of the top level node corresponding to its force type. More...

virtual bool	networkStateIsDifferentFromLocalState (const DtOrganizationManagerNode &node) const

virtual void	invokeNodeAddedCallbacks (const DtUUID &)
	Invokes all callbacks registered for notification that a node has been added. More...

virtual void	invokeNodeRemovedCallbacks (const DtUUID &)
	Invokes all callbacks registered for notification that a node is removed. More...

virtual void	invokeNodeAboutToBeRemovedCallbacks (const DtUUID &)
	Invokes all callbacks registered for notification that a node is about to be removed. More...

virtual DtOrganizationManagerNode *	findNode (DtSharedVrfObjectReference obj) const
	Try and find the org manager node by uuid, entity identifier and then marking text. More...

virtual DtSharedVrfObjectReference	findObject (const DtUUID &uuid) const
	Try to find object by UUID. More...

Protected Attributes
DtVrfObjectManager *	myObjectManager

ForceMap	myTopLevelNodes
	Hash list of top level nodes hashed by force type. More...

UUIDMap	myIdHashList
	Hash list associating entity identifiers with nodes. More...

DtOrgViewCallbackList	myNodeAddedCallbackList

DtOrgViewCallbackList	myNodeRemovedCallbackList

DtOrgViewCallbackList	myNodeAboutToBeRemovedCallbackList

DtOrgViewManagedObjectListManager *	myManagedObjectListManager

virtual DtOrganizationManagerNode *	locateSuperiorNodeForGlobalId (const DtGlobalObjectDesignator &globalId) const
	Methods mainly used internally. More...

virtual bool	isLocal (DtOrganizationManagerNode *node) const

virtual void	printHierarchy () const
	Prints a text representation of the current hierarchy for debugging. More...

virtual void	printNode (DtOrganizationManagerNode *node, int indentLevel=0) const
	Prints a node and all its children recursively. More...

virtual const DtVrfObjectManager *	objectManager () const

virtual DtSharedVrfObjectReference	topLevelObjectForForce (const DtForceType &force) const

virtual DtOrganizationManagerNode *	topLevelNodeForForce (DtForceType force) const

virtual const UUIDMap &	nodes () const

static bool	isTopLevelEntity (const DtEntityType &objectType)

static bool	isOrganizedAggregate (const DtVrfObject *vrfObject)

static bool	isOrganizedEntity (const DtVrfObject *vrfObject)

Detailed Description

This class maintains a hierarchy of the existing organized entities for a simulation based on the contents of Aggregate State PDUs.

It is the central point for making inquiries about the organization of entities in the simulation.

Member Typedef Documentation

typedef boost::unordered_map<DtUUID, DtOrganizationManagerNode*> DtOrganizationView::UUIDMap

typedef boost::unordered_map<int, DtOrganizationManagerNode*> DtOrganizationView::ForceMap

Constructor & Destructor Documentation

DtOrganizationView::DtOrganizationView ( const DtOrganizationView & orig )

protected

Copy constructor not implemented.

DtOrganizationView::DtOrganizationView ( DtVrfObjectManager * objMgr )

Constructor.

Parameters

objMgr The object manager that maintains the list of all entities and objects in the simulation.

virtual DtOrganizationView::~DtOrganizationView ( )

virtual

Destructor.

Member Function Documentation

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

protected

Assignment operator not implemented.

virtual bool DtOrganizationView::init ( )

virtual

Reimplemented in DtOrganizationManager.

virtual DtOrganizationManagerNode* DtOrganizationView::lookupNode ( const DtUUID & ) const

virtual

Methods for inspecting the hierarchy.

virtual DtOrganizationManagerNode* DtOrganizationView::lookupNodeByUUID ( const DtUUID & ) const

virtual

Looks up node by UUID. Call if you know this is a valid vrfUUID, else call lookupNode.

virtual bool DtOrganizationView::removeNode ( const DtUUID & )

virtual

Removes the node represented by the UUID.

virtual bool DtOrganizationView::isSubordinateOfTopLevel ( const DtUUID & ) const

virtual

Returns: true if the specified entity is a direct subordinate of a force level aggregate.

virtual const DtUUID& DtOrganizationView::superior ( const DtUUID & ) const

virtual

Returns: the ID of this entitie's superior.

virtual DtSharedVrfObjectReference DtOrganizationView::superiorVrfObject ( const DtUUID & ) const

virtual

Returns: a pointer to the superior of an entity.

virtual bool DtOrganizationView::isSubordinateOf	(	const DtUUID &	subordinate,
		const DtUUID &	superior
	)		const

virtual

Returns: true if <subordinate> is a direct subordinate of <superior>.

virtual DtOrganizationManagerNode* DtOrganizationView::addEntity ( const DtVrfObject * vrfObject )

virtual

Functions for manipulating the hierarchy.

Creates and adds a new node for this entity.

Reimplemented in DtOrganizationManager.

virtual void DtOrganizationView::removeEntity ( const DtVrfObject * vrfObject )

virtual

Removes the node for this entity from the hierarchy.

Reimplemented in DtOrganizationManager.

virtual void DtOrganizationView::updateAggregate ( const DtVrfObject * vrfObject )

virtual

Updates the connections to the node corresponding to this aggregate.

Reimplemented in DtOrganizationManager.

virtual void DtOrganizationView::updateEntity ( const DtVrfObject * vrfObject )

virtual

Updates the connections to the node corresponding to this entity.

Reimplemented in DtOrganizationManager.

virtual DtOrgViewManagedObjectListConstPtr DtOrganizationView::getList	(	const DtUUID &	aggregate,
		const DtVrfObjectPredicate &	predicate = `DtVrfObjectPredicate::nullPredicate()`,
		bool	reevaluateFlag = `false`,
		DtTime	evaluationPeriod = `0.`
	)		const

virtual

Request a filtered list of subordinates for a given aggregate, based on user-supplied criteria.

The list returned is a shared pointer, and may be used by other requesters of the same list. The list will be released when all references go out of scope.

Note: Maintaining filtered lists may be computationally expensive.

virtual DtOrgViewManagedObjectListConstPtr DtOrganizationView::nullList ( ) const

virtual

virtual DtOrganizationManagerNode* DtOrganizationView::locateSuperiorNodeForGlobalId ( const DtGlobalObjectDesignator & globalId ) const

virtual

Methods mainly used internally.

Searches the current nodes for an aggregate which is claiming the specified global ID as it's subordinate, and returns that node.

virtual bool DtOrganizationView::isLocal ( DtOrganizationManagerNode * node ) const

virtual

Returns: true if the object referred to be this node is locally simulated.

virtual void DtOrganizationView::printHierarchy ( ) const

virtual

Prints a text representation of the current hierarchy for debugging.

virtual void DtOrganizationView::printNode	(	DtOrganizationManagerNode *	node,
		int	indentLevel = `0`
	)		const

virtual

Prints a node and all its children recursively.

virtual const DtVrfObjectManager* DtOrganizationView::objectManager ( ) const

virtual

virtual DtSharedVrfObjectReference DtOrganizationView::topLevelObjectForForce ( const DtForceType & force ) const

virtual

Returns: the top level vrfObject (always local) for the specified force. Calls topLevelNodeForForce and looks up the object.

virtual DtOrganizationManagerNode* DtOrganizationView::topLevelNodeForForce ( DtForceType force ) const

virtual

Returns: the top level node (always local) for the specified force.

virtual const UUIDMap& DtOrganizationView::nodes ( ) const

virtual

Returns: Hash list of nodes by entity id

static bool DtOrganizationView::isTopLevelEntity ( const DtEntityType & objectType )

static

static bool DtOrganizationView::isOrganizedAggregate ( const DtVrfObject * vrfObject )

static

Returns: true if this object is a type which corresponds to a type that should be a potentially non-leaf node in the org hierarchy.

static bool DtOrganizationView::isOrganizedEntity ( const DtVrfObject * vrfObject )

static

Returns: true if this object is a type which corresponds to a type that should be a leaf node in the org hierarchy.

static void DtOrganizationView::vrfObjectAddedCallback	(	const DtVrfObject *	vrfObject,
		void *	usr
	)

static

static void DtOrganizationView::vrfObjectAboutToBeRemovedCallback	(	const DtVrfObject *	vrfObject,
		void *	usr
	)

static

virtual void DtOrganizationView::addNodeAddedCallback	(	DtOrgViewCallbackList::DtCallbackFunctionType	fcn,
		void *	userData
	)		const

virtual

Callback for notification when a child is added to the list of child nodes.

virtual void DtOrganizationView::removeNodeAddedCallback	(	DtOrgViewCallbackList::DtCallbackFunctionType	fcn,
		void *	userData
	)		const

virtual

virtual void DtOrganizationView::addNodeRemovedCallback	(	DtOrgViewCallbackList::DtCallbackFunctionType	fcn,
		void *	userData
	)		const

virtual

Callback for notification when a child is to be removed from the list of child nodes.

This is called after it has been disconnected from parent nodes

virtual void DtOrganizationView::removeNodeRemovedCallback	(	DtOrgViewCallbackList::DtCallbackFunctionType	fcn,
		void *	userData
	)		const

virtual

virtual void DtOrganizationView::addNodeAboutToBeRemovedCallback	(	DtOrgViewCallbackList::DtCallbackFunctionType	fcn,
		void *	userData
	)		const

virtual

Callback for notification when a child is about to be removed from the list of child nodes.

This is called before it has been disconnected from parent nodes

virtual void DtOrganizationView::removeNodeAboutToBeRemovedCallback	(	DtOrgViewCallbackList::DtCallbackFunctionType	fcn,
		void *	userData
	)		const

virtual

virtual void DtOrganizationView::objectUUIDChanged	(	const DtUUID &	oldUUID,
		const DtUUID &	newUUID
	)

virtual

Notification that UUID has changed for the given UUID to the new UUID.

Should only be called for remote objects that are not published by vr-forces

virtual DtOrganizationManagerNode* DtOrganizationView::createOrganizationManagerNode ( ) const

protectedvirtual

Creates a new node to put into the hierarchy.

virtual void DtOrganizationView::processVrfObjectAdded ( const DtVrfObject * vrfObject )

protectedvirtual

virtual void DtOrganizationView::processVrfObjectAboutToBeRemoved ( const DtVrfObject * vrfObject )

protectedvirtual

Looks up vrfObject's superior.

If it exists, removes vrfObject from superior's subordinate manager. Then calls removeEntity().

virtual bool DtOrganizationView::shouldBeAdded ( const DtVrfObject * vrfObject ) const

protectedvirtual

Returns: true if this object should be added to the hierarchy.

virtual void DtOrganizationView::findAndConnectNodeParent ( DtOrganizationManagerNode * node )

protectedvirtual

Searches the existing hierarchy for an aggregate which claims this node, and connects it as a child.

virtual void DtOrganizationView::disconnectNodeParent ( DtOrganizationManagerNode * node )

protectedvirtual

Removes the specified node from the child list of it's current parent, and sets it parent to NULL.

virtual void DtOrganizationView::findAndConnectNodeChildren ( DtOrganizationManagerNode * node )

protectedvirtual

Looks up this vrfObject, and searches the existing hierarchy for any nodes specified in the subordinate manger of this object and connects them to this node as children.

virtual void DtOrganizationView::disconnectNodeChildren ( DtOrganizationManagerNode * node )

protectedvirtual

Disconnects all the children from this node.

virtual void DtOrganizationView::connectNodeToTopLevel	(	DtOrganizationManagerNode *	node,
		bool	allowCreation = `true`
	)

protectedvirtual

Makes this node a child of the top level node corresponding to its force type.

If allowCreation is true, this function will create the appropriate top level entity if it doesn't already exist.

virtual bool DtOrganizationView::networkStateIsDifferentFromLocalState ( const DtOrganizationManagerNode & node ) const

protectedvirtual

Returns: true if ordered list of subordinates in the network state (the VR-Link state repository) is different than the ordered list of subordinates in the given node.

virtual void DtOrganizationView::invokeNodeAddedCallbacks ( const DtUUID & )

protectedvirtual

Invokes all callbacks registered for notification that a node has been added.

virtual void DtOrganizationView::invokeNodeRemovedCallbacks ( const DtUUID & )

protectedvirtual

Invokes all callbacks registered for notification that a node is removed.

This is called after it has been disconnected from parent nodes

virtual void DtOrganizationView::invokeNodeAboutToBeRemovedCallbacks ( const DtUUID & )

protectedvirtual

Invokes all callbacks registered for notification that a node is about to be removed.

This is called before it is disconnected from parent nodes

virtual DtOrganizationManagerNode* DtOrganizationView::findNode ( DtSharedVrfObjectReference obj ) const

protectedvirtual

Try and find the org manager node by uuid, entity identifier and then marking text.

virtual DtSharedVrfObjectReference DtOrganizationView::findObject ( const DtUUID & uuid ) const

protectedvirtual

Try to find object by UUID.

Member Data Documentation

DtVrfObjectManager* DtOrganizationView::myObjectManager

protected

ForceMap DtOrganizationView::myTopLevelNodes

protected

Hash list of top level nodes hashed by force type.

UUIDMap DtOrganizationView::myIdHashList

protected

Hash list associating entity identifiers with nodes.

DtOrgViewCallbackList DtOrganizationView::myNodeAddedCallbackList

mutableprotected

DtOrgViewCallbackList DtOrganizationView::myNodeRemovedCallbackList

mutableprotected

DtOrgViewCallbackList DtOrganizationView::myNodeAboutToBeRemovedCallbackList

mutableprotected

DtOrgViewManagedObjectListManager* DtOrganizationView::myManagedObjectListManager

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjcore/organizationView.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation