VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtOrganizationManagerNode Class Reference
Inheritance diagram for DtOrganizationManagerNode:
Inheritance graph
[legend]

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. More...
 
virtual void setVrfObject (const DtVrfObject *)
 If the object is valid, set it here and it will be used in other routines. More...
 
const DtSharedVrfObjectReferencevrfObject () const
 
virtual int indexOfChild (const DtUUID &) const
 The index of the child in the order. More...
 
virtual const DtList * childList () const
 List of DtOrganizationManagerNode* children (subordinates) of this node. More...
 
virtual DtList * childList ()
 
virtual bool removeChild (const DtOrganizationManagerNode *node)
 Functions for manipulating this node's list of children. More...
 
virtual void removeAllChildren ()
 
virtual void addChild (DtOrganizationManagerNode *node)
 
virtual void setParent (DtOrganizationManagerNode *parent)
 Set/get parent node of this node. More...
 
virtual DtOrganizationManagerNodeparent () const
 
virtual const DtUUIDuuid () const
 Object uuid of this node. More...
 
virtual void setEntityIdentifier (const DtEntityIdentifier &id)
 Entity Id of this node. More...
 
virtual const DtEntityIdentifier & entityIdentifier () const
 
virtual void setIsTopLevel (bool isTopLevel)
 Flag indicating whether or this node is a top-level (i.e. More...
 
virtual bool isTopLevel () const
 
virtual void addChildAddedCallback (DtOrgNodeCallbackFunction fcn, void *userData)
 Callback for notification when a child is added to the list of child nodes. More...
 
virtual void removeChildAddedCallback (DtOrgNodeCallbackFunction fcn, void *userData)
 
virtual void addChildRemovedCallback (DtOrgNodeCallbackFunction fcn, void *userData)
 Callback for notification when a child is about to be removed from the list of child nodes. More...
 
virtual void removeChildRemovedCallback (DtOrgNodeCallbackFunction fcn, void *userData)
 
virtual void addSubordinatesChangedCallback (DtOrgNodeCallbackFunction fcn, void *userData)
 This callback will be called when any subordinates of this node have been added or removed. More...
 
virtual void removeSubordinatesChangedCallback (DtOrgNodeCallbackFunction fcn, void *userData)
 

Protected Member Functions

virtual void invokeSubordinatesChangedCallbacks (const DtUUID &) const
 Invokes all the registered reog callbacks with objectId() as the argument. More...
 
virtual void invokeChildAddedCallbacks (const DtUUID &) const
 Invokes all callbacks registered for notification that a child node has been added. More...
 
virtual void invokeChildRemovedCallbacks (const DtUUID &) const
 Invokes all callbacks registered for notification that a child node is about to be removed. More...
 
void removeAllSubordinatesChangedCallbacks ()
 Called from the destructor. More...
 
virtual void childAdded (DtOrganizationManagerNode *)
 Child added. Called internally when a child has been added to the list. More...
 
virtual void childRemoved (const DtOrganizationManagerNode *)
 Child removed. Called internally when a child is removed. More...
 

Protected Attributes

DtList myChildList
 DtList of DtOrganizationManagerNode pointers. More...
 
DtOrganizationManagerNodemyParentNode
 
DtEntityIdentifier myEntityIdentifier
 
bool myIsTopLevel
 
DtList mySubordinatesChangedCallbackList
 
std::list< DtOrgNodeCallbackInfomyChildAddedCallbackList
 
std::list< DtOrgNodeCallbackInfomyChildRemovedCallbackList
 
DtSharedVrfObjectReference myVrfObject
 
std::map< DtUUID, intmyChildOrder
 

Private Member Functions

 DtOrganizationManagerNode (const DtOrganizationManagerNode &orig)
 Not implemented. More...
 
DtOrganizationManagerNodeoperator= (const DtOrganizationManagerNode &orig)
 Not implemented. More...
 

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
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
virtual void DtOrganizationManagerNode::addChild ( DtOrganizationManagerNode node)
virtual
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
virtual void DtOrganizationManagerNode::setVrfObject ( const DtVrfObject )
virtual

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

const DtSharedVrfObjectReference& DtOrganizationManagerNode::vrfObject ( ) const
inline
virtual const DtUUID& DtOrganizationManagerNode::uuid ( ) const
virtual

Object uuid of this node.

Reimplemented in DtOrbatManagerNode.

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

Entity Id of this node.

virtual const DtEntityIdentifier& DtOrganizationManagerNode::entityIdentifier ( ) const
virtual
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
virtual void DtOrganizationManagerNode::addChildAddedCallback ( DtOrgNodeCallbackFunction  fcn,
void *  userData 
)
virtual

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

virtual void DtOrganizationManagerNode::removeChildAddedCallback ( DtOrgNodeCallbackFunction  fcn,
void *  userData 
)
virtual
virtual void DtOrganizationManagerNode::addChildRemovedCallback ( DtOrgNodeCallbackFunction  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 ( DtOrgNodeCallbackFunction  fcn,
void *  userData 
)
virtual
virtual void DtOrganizationManagerNode::addSubordinatesChangedCallback ( DtOrgNodeCallbackFunction  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 ( DtOrgNodeCallbackFunction  fcn,
void *  userData 
)
virtual
virtual int DtOrganizationManagerNode::indexOfChild ( const DtUUID ) const
virtual

The index of the child in the order.

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.

virtual void DtOrganizationManagerNode::childAdded ( DtOrganizationManagerNode )
protectedvirtual

Child added. Called internally when a child has been added to the list.

Reimplemented in DtOrbatManagerNode.

virtual void DtOrganizationManagerNode::childRemoved ( const DtOrganizationManagerNode )
protectedvirtual

Child removed. Called internally when a child is removed.

Reimplemented in DtOrbatManagerNode.

Member Data Documentation

DtList DtOrganizationManagerNode::myChildList
protected

DtList of DtOrganizationManagerNode pointers.

DtOrganizationManagerNode* DtOrganizationManagerNode::myParentNode
protected
DtEntityIdentifier DtOrganizationManagerNode::myEntityIdentifier
protected
bool DtOrganizationManagerNode::myIsTopLevel
protected
DtList DtOrganizationManagerNode::mySubordinatesChangedCallbackList
protected
std::list<DtOrgNodeCallbackInfo> DtOrganizationManagerNode::myChildAddedCallbackList
protected
std::list<DtOrgNodeCallbackInfo> DtOrganizationManagerNode::myChildRemovedCallbackList
protected
DtSharedVrfObjectReference DtOrganizationManagerNode::myVrfObject
protected
std::map<DtUUID, int> DtOrganizationManagerNode::myChildOrder
mutableprotected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)