DtVrfSubordinateManager Class Reference

Inheritance diagram for DtVrfSubordinateManager:

Public Member Functions
	DtVrfSubordinateManager (DtVrfObjectManager *vrfObjectManager)
	Constructor.
	DtVrfSubordinateManager (const DtVrfSubordinateManager &orig)
	Copy Constructor.
const DtVrfSubordinateManager &	operator= (const DtVrfSubordinateManager &orig)
	Assignment Operator.
virtual	~DtVrfSubordinateManager ()
	Destructor.
virtual DtSubordinateManager *	clone () const
	Creates a new manager calling the copy constructor and returns the result.
virtual DtVrfObject *	firstVrfSubordinate () const
virtual DtVrfObject *	lastVrfSubordinate () const
virtual DtVrfObject *	firstVrfHealthySubordinate () const
virtual const DtKeyedVrfObjectIterator &	vrfIterator () const
	Allocates and returns an iterator to iterate over this subObject list.
Public Member Functions inherited from DtSubordinateManager
	DtSubordinateManager (DtVrfObjectManager *simObjectManager)
	Constructor.
	DtSubordinateManager (const DtSubordinateManager &orig)
	Copy Constructor.
const DtSubordinateManager &	operator= (const DtSubordinateManager &orig)
	Assignment Operator.
virtual	~DtSubordinateManager ()
	Destructor.
virtual bool	addSubordinate (DtVrfObject *subordinate, int designator=0)
	All adding subordinate calls will fail if the specified designator is already in use.
virtual bool	addSubordinateBefore (DtVrfObject *subordinate, DtVrfObject *beforeObject, int designator=0)
virtual bool	addSubordinateAfter (DtVrfObject *subordinate, DtVrfObject *afterObject, int designator=0)
	note that if the afterObject is not found, the object is added to the end of the list
virtual void	removeSubordinate (DtVrfObject *subordinate)
	Removes given object as a subordinate.
virtual void	removeAllSubordinates ()
	note that if the beforeObject is not found, the object is added to the end of the list
virtual int	numSubordinates () const
	Returns the number of subrodinates managed by this object.
virtual DtVrfObject *	firstSubordinate () const
	useful to be able to get the first or last in the list without needed to spawn an iterator.
virtual DtVrfObject *	lastSubordinate () const
virtual bool	isSubordinate (const DtEntityIdentifier &id) const
	Returns true if this object is listed in this subordinate manager.
virtual bool	isSubordinate (DtVrfObject *simObj) const
const DtKeyedSimObjectIterator &	iterator () const
	allocates and returns an iterator to iterate over this subObject list.
virtual int	designatorForSubordinate (DtVrfObject *subordinate) const
	Returns the designator number for a subordinate in the list.
virtual int	designatorForSubordinate (const DtEntityIdentifier &id) const
virtual DtVrfObject *	subordinateForDesignator (int designator) const
	Returns the subordinate with a particular designator.
virtual bool	setDesignator (const DtEntityIdentifier &id, int designator)
	Sets the designator of a subordinate to the specified value.
virtual bool	setDesignator (DtVrfObject *subordinate, int designator)
virtual int	firstAvailableDesignator (int start=1) const
	Returns the lowest unused designator.
virtual int	maxUsedDesignator () const
	Returns the highest used designator.
virtual void	reorderToDesignatorOrder ()
	Causes the order of the subordinate list to be in ascending designator order.
virtual void	designatorOrderedList (std::vector< DtEntityIdentifier > &designatorOrderedList) const
	Returns list of DtEntityIdentifiers, ordered from lowest to highest designator.
virtual void	setSubordinateOrder (const std::vector< DtEntityIdentifier > &orderedList)
	Removes all subordinates from the subordinate manager and then adds new subordinates in the order given by orderedList.
virtual void	addSubordinatesChangedCallback (DtSubordinateManagerCallbackFcn fcn, void *userData)
	Registers callback for notification of any change to the subordinates (addition, removal, reordering).
virtual void	removeSubordinatesChangedCallback (DtSubordinateManagerCallbackFcn fcn, void *userData)
	Removes callback for notification of any change to the subordinates (addition, removal, reordering).

Protected Attributes
DtKeyedVrfObjectIterator	myVrfIterator
Protected Attributes inherited from DtSubordinateManager
DtVrfObjectManager *	mySimObjectManager
DtKeyedSimObjectIterator *	myIterator
DtList	mySubordinateList
	The list of entity id's is kept since order is important.
DtEntityIdIntAssociationList	myDesignatorTable
	The table of entity id's and designators is used to associate a designator with each entity.
std::vector < DtSubordinateManagerCallbackInfo >	mySubordinatesChangedCallbackList
	List of DtSubordinateCallbackFcn*s.

Private Member Functions
	DtVrfSubordinateManager ()
	Default Constructor. Not Implemented.

Additional Inherited Members
Protected Member Functions inherited from DtSubordinateManager
void	copySubordinateList (const DtList &list)
void	emptySubordinateList ()
DtListItem *	findSubordinateItem (const DtEntityIdentifier &id) const
	Searches the list for a given entity id.
virtual void	invokeSubordinatesChangedCallbacks () const

Constructor & Destructor Documentation

DtVrfSubordinateManager::DtVrfSubordinateManager ( )

private

Default Constructor. Not Implemented.

DtVrfSubordinateManager::DtVrfSubordinateManager

(

DtVrfObjectManager *

vrfObjectManager

)

Constructor.

DtVrfSubordinateManager::DtVrfSubordinateManager

(

const DtVrfSubordinateManager &

orig

)

Copy Constructor.

virtual DtVrfSubordinateManager::~DtVrfSubordinateManager ( )

virtual

Destructor.

Member Function Documentation

const DtVrfSubordinateManager& DtVrfSubordinateManager::operator=

(

const DtVrfSubordinateManager &

orig

)

Assignment Operator.

virtual DtSubordinateManager* DtVrfSubordinateManager::clone ( ) const

virtual

Creates a new manager calling the copy constructor and returns the result.

Reimplemented from DtSubordinateManager.

virtual DtVrfObject* DtVrfSubordinateManager::firstVrfSubordinate ( ) const

virtual

virtual DtVrfObject* DtVrfSubordinateManager::lastVrfSubordinate ( ) const

virtual

virtual DtVrfObject* DtVrfSubordinateManager::firstVrfHealthySubordinate ( ) const

virtual

virtual const DtKeyedVrfObjectIterator& DtVrfSubordinateManager::vrfIterator ( ) const

virtual

Allocates and returns an iterator to iterate over this subObject list.

Member Data Documentation

DtKeyedVrfObjectIterator DtVrfSubordinateManager::myVrfIterator

protected

---

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

• include/vrfobjcore/vrfSubordMgr.h