DtAggregateNode Class Reference

DtAggregateNode represents a node in an aggregate hierarchy. More...

List of all members.

Public Types
typedef DtAggregateData *(*	DtAggregateDataCreator )()
	Function prototype for functions that create DtAggregateData.
Public Member Functions
	DtAggregateNode (const DtEntityIdentifier &objectId, DtOrganizationManager &organizationManager)
	constructor
virtual	~DtAggregateNode ()
	destructor
virtual void	addChild (DtAggregateNodePtr child)
	Adds node as a child.
const DtAggregateNodeList &	childList () const
virtual const DtEntityIdentifier &	objectId () const
virtual void	print () const
	Prints object Id and contents of node. For debugging.
virtual DtAggregateDataPtr	data ()
	DtAggregateData contained in this node.
virtual DtAggregateDataConstPtr	data () const
	DtAggregateData contained in this node.
virtual DtOrgViewManagedObjectListConstPtr	taskableSubordinates () const
	Accessors for various subsets of subordinate lists.
virtual DtOrgViewManagedObjectListConstPtr	ableToMoveSubordinates () const
	Accessors for various subsets of subordinate lists.
virtual DtOrgViewManagedObjectListConstPtr	allSubordinates () const
	Accessors for various subsets of subordinate lists.
Static Public Member Functions
static void	setAggregateDataCreator (DtAggregateDataCreator creator)
	Function to be used for creating DtAggregateData.
static DtAggregateDataCreator	aggregateDataCreator (void)
	Function to be used for creating DtAggregateData.
Protected Attributes
DtEntityIdentifier	myObjectId
	Object Id of entity this node is assoicated with.
DtAggregateDataPtr	myData
	Data record containing state information assoicated with the node.
DtAggregateNodeList	myChildNodes
	List of children (aggregate subordinates) for this node.
DtOrganizationManager &	myOrganizationManager
DtOrgViewManagedObjectListConstPtr	myTaskableSubordinates
DtOrgViewManagedObjectListConstPtr	myAbleToMoveSubordinates
DtOrgViewManagedObjectListConstPtr	myAllSubordinates
Static Protected Attributes
static DtAggregateDataCreator	theAggregateDataCreator
	Creation function used to create the DtAggregateData object maintained by this class.
Private Member Functions
	DtAggregateNode (const DtAggregateNode &orig)
	Copy Constructor not implemented -- Copy Not Allowed.
DtAggregateNode &	operator= (const DtAggregateNode &orig)
	Assignment Operator Not implemented - Assignment Not Allowed.

---

Detailed Description

DtAggregateNode represents a node in an aggregate hierarchy.

Contains a generic data record, which can be used to hold any type of data of interest about a node in an aggregate hierarchy.

---

Member Typedef Documentation

typedef DtAggregateData*(* DtAggregateNode::DtAggregateDataCreator)()

Function prototype for functions that create DtAggregateData.

---

Constructor & Destructor Documentation

DtAggregateNode::DtAggregateNode	(	const DtEntityIdentifier &	objectId,
		DtOrganizationManager &	organizationManager
	)

constructor

virtual DtAggregateNode::~DtAggregateNode

(

)

[virtual]

destructor

DtAggregateNode::DtAggregateNode

(

const DtAggregateNode &

orig

)

[private]

Copy Constructor not implemented -- Copy Not Allowed.

---

Member Function Documentation

virtual void DtAggregateNode::addChild

(

DtAggregateNodePtr

child

)

[virtual]

Adds node as a child.

const DtAggregateNodeList& DtAggregateNode::childList

(

)

const

Returns:

List of children of this node

virtual const DtEntityIdentifier& DtAggregateNode::objectId

(

)

const [virtual]

Returns:

<site, application, object> identifier for this node

virtual DtAggregateDataPtr DtAggregateNode::data

(

)

[virtual]

DtAggregateData contained in this node.

virtual DtAggregateDataConstPtr DtAggregateNode::data

(

)

const [virtual]

DtAggregateData contained in this node.

virtual void DtAggregateNode::print

(

)

const [virtual]

Prints object Id and contents of node. For debugging.

static void DtAggregateNode::setAggregateDataCreator

(

DtAggregateDataCreator

creator

)

[static]

Function to be used for creating DtAggregateData.

Can be used to change the type of DtAggregateData object that this class creates and maintains.

static DtAggregateDataCreator DtAggregateNode::aggregateDataCreator

(

void

)

[static]

Function to be used for creating DtAggregateData.

Can be used to change the type of DtAggregateData object that this class creates and maintains.

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::taskableSubordinates

(

)

const [virtual]

Accessors for various subsets of subordinate lists.

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::ableToMoveSubordinates

(

)

const [virtual]

Accessors for various subsets of subordinate lists.

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::allSubordinates

(

)

const [virtual]

Accessors for various subsets of subordinate lists.

DtAggregateNode& DtAggregateNode::operator=

(

const DtAggregateNode &

orig

)

[private]

Assignment Operator Not implemented - Assignment Not Allowed.

---

Member Data Documentation

DtEntityIdentifier DtAggregateNode::myObjectId [protected]

Object Id of entity this node is assoicated with.

DtAggregateDataPtr DtAggregateNode::myData [protected]

Data record containing state information assoicated with the node.

DtAggregateNodeList DtAggregateNode::myChildNodes [protected]

List of children (aggregate subordinates) for this node.

May be empty (node represents an individual entity or true aggregate).

DtAggregateDataCreator DtAggregateNode::theAggregateDataCreator [static, protected]

Creation function used to create the DtAggregateData object maintained by this class.

DtOrganizationManager& DtAggregateNode::myOrganizationManager [protected]

DtOrgViewManagedObjectListConstPtr DtAggregateNode::myTaskableSubordinates [protected]

DtOrgViewManagedObjectListConstPtr DtAggregateNode::myAbleToMoveSubordinates [protected]

DtOrgViewManagedObjectListConstPtr DtAggregateNode::myAllSubordinates [protected]

---

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

• include/vrfobjcore/aggregateNode.h