DtAggregateNode Class Reference

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

Public Types
typedef DtAggregateData *(*	DtAggregateDataCreator )()
	Function prototype for functions that create DtAggregateData.

Public Member Functions
	DtAggregateNode (const DtUUID &uuid, DtOrganizationManager &organizationManager)
	constructor
	DtAggregateNode (DtOrganizationManager &organizationManager)
virtual	~DtAggregateNode ()
	destructor
virtual void	addChild (DtAggregateNodePtr child)
	Adds node as a child.
virtual bool	removeChild (const DtUUID &child)
	Removes a child from this aggregate. Returns false if child is not found.
const DtAggregateNodeChildMap &	childList () const
virtual const DtSharedVrfObjectReference &	entity () const
virtual void	print () const
	Prints object Id and contents of node. For debugging.
virtual const DtUUID &	uuid () const
	Returns UUID of this node.
bool	isAggregate () const
	True if this node represents an aggregate (false if individual)
virtual DtAggregateDataPtr	data ()
	DtAggregateData contained in this node.
virtual DtAggregateDataConstPtr	data () const
virtual DtOrgViewManagedObjectListConstPtr	taskableSubordinates () const
	Accessors for various subsets of subordinate lists.
virtual DtOrgViewManagedObjectListConstPtr	ableToMoveSubordinates () const
virtual DtOrgViewManagedObjectListConstPtr	allSubordinates () const
virtual DtOrgViewManagedObjectListConstPtr	subordinatesToIncludeInSpatialModel () const

Static Public Member Functions
static void	setAggregateDataCreator (DtAggregateDataCreator creator)
	Function to be used for creating DtAggregateData.
static DtAggregateDataCreator	aggregateDataCreator (void)

Protected Attributes
DtSharedVrfObjectReference	myEntity
	Object Id of entity this node is assoicated with.
DtAggregateDataPtr	myData
	Data record containing state information assoicated with the node.
DtAggregateNodeChildMap	myChildNodes
	List of children (aggregate subordinates) for this node.
DtOrganizationManager &	myOrganizationManager
DtOrgViewManagedObjectListConstPtr	myTaskableSubordinates
DtOrgViewManagedObjectListConstPtr	mySubordinatesToIncludeInSpatialModel
DtOrgViewManagedObjectListConstPtr	myAbleToMoveSubordinates
DtOrgViewManagedObjectListConstPtr	myAllSubordinates
bool	myIsAggregate

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 DtUUID &	uuid,
		DtOrganizationManager &	organizationManager
	)

constructor

DtAggregateNode::DtAggregateNode

(

DtOrganizationManager &

organizationManager

)

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.

virtual bool DtAggregateNode::removeChild ( const DtUUID &  child )

virtual

Removes a child from this aggregate. Returns false if child is not found.

const DtAggregateNodeChildMap& DtAggregateNode::childList

(

)

const

Returns

List of children of this node

virtual const DtSharedVrfObjectReference& DtAggregateNode::entity ( ) const

virtual

Returns

entity represented by this node

virtual DtAggregateDataPtr DtAggregateNode::data ( )

virtual

DtAggregateData contained in this node.

virtual DtAggregateDataConstPtr DtAggregateNode::data ( ) const

virtual

virtual void DtAggregateNode::print ( ) const

virtual

Prints object Id and contents of node. For debugging.

virtual const DtUUID& DtAggregateNode::uuid ( ) const

virtual

Returns UUID of this node.

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

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::taskableSubordinates ( ) const

virtual

Accessors for various subsets of subordinate lists.

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::ableToMoveSubordinates ( ) const

virtual

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::allSubordinates ( ) const

virtual

virtual DtOrgViewManagedObjectListConstPtr DtAggregateNode::subordinatesToIncludeInSpatialModel ( ) const

virtual

bool DtAggregateNode::isAggregate ( ) const

inline

True if this node represents an aggregate (false if individual)

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

private

Assignment Operator Not implemented - Assignment Not Allowed.

Member Data Documentation

DtSharedVrfObjectReference DtAggregateNode::myEntity

protected

Object Id of entity this node is assoicated with.

DtAggregateDataPtr DtAggregateNode::myData

protected

Data record containing state information assoicated with the node.

DtAggregateNodeChildMap 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

staticprotected

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

DtOrganizationManager& DtAggregateNode::myOrganizationManager

protected

DtOrgViewManagedObjectListConstPtr DtAggregateNode::myTaskableSubordinates

protected

DtOrgViewManagedObjectListConstPtr DtAggregateNode::mySubordinatesToIncludeInSpatialModel

protected

DtOrgViewManagedObjectListConstPtr DtAggregateNode::myAbleToMoveSubordinates

protected

DtOrgViewManagedObjectListConstPtr DtAggregateNode::myAllSubordinates

protected

bool DtAggregateNode::myIsAggregate

protected

---

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

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