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< DtUUID > &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 void	setVrfObject (DtVrfObject *)
	If the object is valid, set it here and it will be used in other routines.
const DtSharedVrfObjectReference &	vrfObject ()
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	setUUID (const DtUUID &id)
	Object uuid of this node.
virtual const DtUUID &	uuid () const
	Object uuid of this node.
virtual void	setEntityIdentifier (const DtEntityIdentifier &id)
	Entity Id of this node.
virtual const DtEntityIdentifier &	entityIdentifier () const
	Entity 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 (DtUUIDCallbackFunction fcn, void *userData)
	Callback for notification when a child is added to the list of child nodes.
virtual void	removeChildAddedCallback (DtUUIDCallbackFunction fcn, void *userData)
	Callback for notification when a child is added to the list of child nodes.
virtual void	addChildRemovedCallback (DtUUIDCallbackFunction fcn, void *userData)
	Callback for notification when a child is about to be removed from the list of child nodes.
virtual void	removeChildRemovedCallback (DtUUIDCallbackFunction fcn, void *userData)
	Callback for notification when a child is about to be removed from the list of child nodes.
virtual void	addSubordinatesChangedCallback (DtUUIDCallbackFunction fcn, void *userData)
	This callback will be called when any subordinates of this node have been added or removed.
virtual void	removeSubordinatesChangedCallback (DtUUIDCallbackFunction 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 DtUUID &) const
	Invokes all the registered reog callbacks with objectId() as the argument.
virtual void	invokeChildAddedCallbacks (const DtUUID &) const
	Invokes all callbacks registered for notification that a child node has been added.
virtual void	invokeChildRemovedCallbacks (const DtUUID &) 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
DtUUID	myUUID
DtEntityIdentifier	myEntityIdentifier
bool	myIsTopLevel
DtList	mySubordinatesChangedCallbackList
std::list< DtUUIDCallbackInfo >	myChildAddedCallbackList
std::list< DtUUIDCallbackInfo >	myChildRemovedCallbackList
DtSharedVrfObjectReference	myVrfObject

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< DtUUID > &  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::setVrfObject ( DtVrfObject *  )

virtual

If the object is valid, set it here and it will be used in other routines.

const DtSharedVrfObjectReference& DtOrganizationManagerNode::vrfObject ( )

inline

virtual void DtOrganizationManagerNode::setUUID ( const DtUUID &  id )

virtual

Object uuid of this node.

virtual const DtUUID& DtOrganizationManagerNode::uuid ( ) const

virtual

Object uuid of this node.

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

virtual

Entity Id of this node.

virtual const DtEntityIdentifier& DtOrganizationManagerNode::entityIdentifier ( ) const

virtual

Entity 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 ( DtUUIDCallbackFunction  fcn, void *  userData  )

virtual

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

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

virtual

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

virtual void DtOrganizationManagerNode::addChildRemovedCallback ( DtUUIDCallbackFunction  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 ( DtUUIDCallbackFunction  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 ( DtUUIDCallbackFunction  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 ( DtUUIDCallbackFunction  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 DtUUID &  ) const

protectedvirtual

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

virtual void DtOrganizationManagerNode::invokeChildAddedCallbacks ( const DtUUID &  ) const

protectedvirtual

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

virtual void DtOrganizationManagerNode::invokeChildRemovedCallbacks ( const DtUUID &  ) 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

DtUUID DtOrganizationManagerNode::myUUID

protected

DtEntityIdentifier DtOrganizationManagerNode::myEntityIdentifier

protected

bool DtOrganizationManagerNode::myIsTopLevel

protected

DtList DtOrganizationManagerNode::mySubordinatesChangedCallbackList

protected

std::list<DtUUIDCallbackInfo> DtOrganizationManagerNode::myChildAddedCallbackList

protected

std::list<DtUUIDCallbackInfo> DtOrganizationManagerNode::myChildRemovedCallbackList

protected

DtSharedVrfObjectReference DtOrganizationManagerNode::myVrfObject

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfobjcore/organizationManagerNode.h