DtOrganizationManagerNode Class Reference

Contains the declaration of DtOrganizationManagerNode, the class that represents a single node the hierarchy of organized entities. More...

Public Member Functions
	DtOrganizationManagerNode ()
virtual	~DtOrganizationManagerNode ()
virtual void	orderChildren (const std::vector< DtEntityIdentifier > &childOrder)
	Sorts the childList of this node so that the order of the nodes reflects the order of the entity identifiers in the supplied vector.
virtual const DtList *	childList () const
	List of DtOrganizationManagerNode* children (subordinates) of this node.
virtual DtList *	childList ()
	List of DtOrganizationManagerNode* children (subordinates) of this node.
virtual bool	removeChild (const DtOrganizationManagerNode *node)
	Functions for manipulating this node's list of children.
virtual void	removeAllChildren ()
	Functions for manipulating this node's list of children.
virtual void	addChild (DtOrganizationManagerNode *node)
	Functions for manipulating this node's list of children.
virtual void	setParent (DtOrganizationManagerNode *parent)
	Set/get parent node of this node.
virtual DtOrganizationManagerNode *	parent () const
	Set/get parent node of this node.
virtual void	setObjectId (const DtEntityIdentifier &id)
	Object Id of this node.
virtual const DtEntityIdentifier &	objectId () const
	Object Id of this node.
virtual void	setIsTopLevel (bool isTopLevel)
	Flag indicating whether or this node is a top-level (i.e.
virtual bool	isTopLevel () const
	Flag indicating whether or this node is a top-level (i.e.
virtual void	addChildAddedCallback (DtEntityIdentifierCallbackFunction fcn, void *userData)
	Callback for notification when a child is added to the list of child nodes.
virtual void	removeChildAddedCallback (DtEntityIdentifierCallbackFunction fcn, void *userData)
	Callback for notification when a child is added to the list of child nodes.
virtual void	addChildRemovedCallback (DtEntityIdentifierCallbackFunction fcn, void *userData)
	Callback for notification when a child is about to be removed from the list of child nodes.
virtual void	removeChildRemovedCallback (DtEntityIdentifierCallbackFunction fcn, void *userData)
	Callback for notification when a child is about to be removed from the list of child nodes.
virtual void	addSubordinatesChangedCallback (DtEntityIdentifierCallbackFunction fcn, void *userData)
	This callback will be called when any subordinates of this node have been added or removed.
virtual void	removeSubordinatesChangedCallback (DtEntityIdentifierCallbackFunction fcn, void *userData)
	This callback will be called when any subordinates of this node have been added or removed.

Protected Member Functions
virtual void	invokeSubordinatesChangedCallbacks (const DtEntityIdentifier &entId) const
	Invokes all the registered reog callbacks with objectId() as the argument.
virtual void	invokeChildAddedCallbacks (const DtEntityIdentifier &entId) const
	Invokes all callbacks registered for notification that a child node has been added.
virtual void	invokeChildRemovedCallbacks (const DtEntityIdentifier &entId) const
	Invokes all callbacks registered for notification that a child node is about to be removed.
void	removeAllSubordinatesChangedCallbacks ()
	Called from the destructor.

Protected Attributes
DtList	myChildList
	DtList of DtOrganizationManagerNode pointers.
DtOrganizationManagerNode *	myParentNode
DtEntityIdentifier	myObjectId
bool	myIsTopLevel
DtList	mySubordinatesChangedCallbackList
std::list < DtEntityIdentifierCallbackInfo >	myChildAddedCallbackList
std::list < DtEntityIdentifierCallbackInfo >	myChildRemovedCallbackList

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

Detailed Description

Contains the declaration of DtOrganizationManagerNode, the class that represents a single node the hierarchy of organized entities.

An instance of this class is a single node in an organization hierarchy.

Constructor & Destructor Documentation

DtOrganizationManagerNode::DtOrganizationManagerNode

(

)

virtual DtOrganizationManagerNode::~DtOrganizationManagerNode ( )

virtual

DtOrganizationManagerNode::DtOrganizationManagerNode ( const DtOrganizationManagerNode &  orig )

private

Not implemented.

Member Function Documentation

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

private

Not implemented.

virtual const DtList* DtOrganizationManagerNode::childList ( ) const

virtual

List of DtOrganizationManagerNode* children (subordinates) of this node.

virtual DtList* DtOrganizationManagerNode::childList ( )

virtual

List of DtOrganizationManagerNode* children (subordinates) of this node.

virtual bool DtOrganizationManagerNode::removeChild ( const DtOrganizationManagerNode *  node )

virtual

Functions for manipulating this node's list of children.

Callbacks are invoked when these operations succeed.

virtual void DtOrganizationManagerNode::removeAllChildren ( )

virtual

Functions for manipulating this node's list of children.

Callbacks are invoked when these operations succeed.

virtual void DtOrganizationManagerNode::addChild ( DtOrganizationManagerNode *  node )

virtual

Functions for manipulating this node's list of children.

Callbacks are invoked when these operations succeed.

virtual void DtOrganizationManagerNode::orderChildren ( const std::vector< DtEntityIdentifier > &  childOrder )

virtual

Sorts the childList of this node so that the order of the nodes reflects the order of the entity identifiers in the supplied vector.

IDs in the vector that don't have child nodes are ignored. Child nodes that don't have a corresponding ID in the vector are placed at the end of the list in the same relative order to each other as they started in. No childAdded/childRemoved callbacks are invoked as a result of this call.

virtual void DtOrganizationManagerNode::setParent ( DtOrganizationManagerNode *  parent )

virtual

Set/get parent node of this node.

virtual DtOrganizationManagerNode* DtOrganizationManagerNode::parent ( ) const

virtual

Set/get parent node of this node.

virtual void DtOrganizationManagerNode::setObjectId ( const DtEntityIdentifier &  id )

virtual

Object Id of this node.

virtual const DtEntityIdentifier& DtOrganizationManagerNode::objectId ( ) const

virtual

Object Id of this node.

virtual void DtOrganizationManagerNode::setIsTopLevel ( bool  isTopLevel )

virtual

Flag indicating whether or this node is a top-level (i.e.

force-level) aggregate.

virtual bool DtOrganizationManagerNode::isTopLevel ( ) const

virtual

Flag indicating whether or this node is a top-level (i.e.

force-level) aggregate.

virtual void DtOrganizationManagerNode::addChildAddedCallback ( DtEntityIdentifierCallbackFunction  fcn, void *  userData  )

virtual

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

virtual void DtOrganizationManagerNode::removeChildAddedCallback ( DtEntityIdentifierCallbackFunction  fcn, void *  userData  )

virtual

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

virtual void DtOrganizationManagerNode::addChildRemovedCallback ( DtEntityIdentifierCallbackFunction  fcn, void *  userData  )

virtual

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

virtual void DtOrganizationManagerNode::removeChildRemovedCallback ( DtEntityIdentifierCallbackFunction  fcn, void *  userData  )

virtual

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

virtual void DtOrganizationManagerNode::addSubordinatesChangedCallback ( DtEntityIdentifierCallbackFunction  fcn, void *  userData  )

virtual

This callback will be called when any subordinates of this node have been added or removed.

It will only be called once the operation is complete. (i.e. it is possible for a subordinate to be added temporarily, then removed all as part of one operation. The callbacks will not be invoked in that case.) The entity ID of the changed subordinate is passed in the call.

virtual void DtOrganizationManagerNode::removeSubordinatesChangedCallback ( DtEntityIdentifierCallbackFunction  fcn, void *  userData  )

virtual

This callback will be called when any subordinates of this node have been added or removed.

It will only be called once the operation is complete. (i.e. it is possible for a subordinate to be added temporarily, then removed all as part of one operation. The callbacks will not be invoked in that case.) The entity ID of the changed subordinate is passed in the call.

virtual void DtOrganizationManagerNode::invokeSubordinatesChangedCallbacks ( const DtEntityIdentifier &  entId ) const

protectedvirtual

Invokes all the registered reog callbacks with objectId() as the argument.

virtual void DtOrganizationManagerNode::invokeChildAddedCallbacks ( const DtEntityIdentifier &  entId ) const

protectedvirtual

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

virtual void DtOrganizationManagerNode::invokeChildRemovedCallbacks ( const DtEntityIdentifier &  entId ) const

protectedvirtual

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

void DtOrganizationManagerNode::removeAllSubordinatesChangedCallbacks ( )

protected

Called from the destructor.

Member Data Documentation

DtList DtOrganizationManagerNode::myChildList

protected

DtList of DtOrganizationManagerNode pointers.

DtOrganizationManagerNode* DtOrganizationManagerNode::myParentNode

protected

DtEntityIdentifier DtOrganizationManagerNode::myObjectId

protected

bool DtOrganizationManagerNode::myIsTopLevel

protected

DtList DtOrganizationManagerNode::mySubordinatesChangedCallbackList

protected

std::list<DtEntityIdentifierCallbackInfo> DtOrganizationManagerNode::myChildAddedCallbackList

protected

std::list<DtEntityIdentifierCallbackInfo> DtOrganizationManagerNode::myChildRemovedCallbackList

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/orgMgrNode.h