VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtOrgViewManagedObjectList Class Reference

Instances of DtOrgViewManagedObjectList are filtered lists of subordinates for a given aggregate. More...

List of all members.

Public Types

typedef std::list< DtVrfObject * >
::iterator 
iterator
typedef std::list< DtVrfObject * >
::const_iterator 
const_iterator

Public Member Functions

virtual ~DtOrgViewManagedObjectList ()
 Destructor.
virtual const DtEntityIdentifier & aggregateId () const
 Entity Identifier of the aggregate whose subordinates are contained within this list.
virtual const
DtVrfObjectPredicate
predicate () const
 Returns the predicate which determines membership in the list.
virtual bool reevaluatePeriodically () const
 Returns true if this list get reevaluated.
virtual DtTime evaluationPeriod () const
 Returns the evaluation interval.
virtual iterator begin ()
virtual const_iterator begin () const
virtual iterator end ()
virtual const_iterator end () const
virtual size_t size () const

Static Public Member Functions

static
DtOrgViewManagedObjectListPtr 
create (DtOrganizationView &organizationView, const DtEntityIdentifier &aggregateId, const DtVrfObjectPredicate &predicate, bool reevaluatePeriodically=false, DtTime evaluationPeriod=0.0)
 Calls constructor and init().

Protected Member Functions

 DtOrgViewManagedObjectList (DtOrganizationView &organizationView, const DtEntityIdentifier &aggregateId, const DtVrfObjectPredicate &predicate, bool reevaluatePeriodically=false, DtTime evaluationPeriod=0.0)
 Constructor Protected to control creation.
virtual void init ()
 Initializer, called by create() after construction.
virtual void processChildAdded (DtEntityIdentifier eid)
virtual void processChildRemoved (DtEntityIdentifier eid)
virtual void processPredicateCallback (DtVrfObject *vrfObject, DtVrfObjectPredicateEvaluator *predicateEval)
virtual void processNodeAdded (DtEntityIdentifier eid)
virtual void processNodeRemoved (DtEntityIdentifier eid)
virtual void processObjectRemoved (DtVrfObject *vrfObject)
virtual void registerAggregateNodeCallbacks ()
virtual void registerOrgViewCallbacks ()
virtual void registerObjectManagerCallbacks ()
virtual void populateList ()
virtual void add (DtVrfObject *obj)
 Add/remove objects to our list of filtered objects.
virtual void remove (DtVrfObject *obj)
 Add/remove objects to our list of filtered objects.
void unregisterAggregateNodeCallbacks ()
void unregisterOrgViewCallbacks ()
void unregisterPredicateCallbacksForAllChildren ()
void unregisterPredicateCallbacks (DtVrfObject &object)
void unregisterObjectManagerCallbacks ()

Static Protected Member Functions

static void childAddedCallback (DtEntityIdentifier eid, void *userData)
 Callback invoked when child is added to aggregate's list of child nodes.
static void childRemovedCallback (DtEntityIdentifier eid, void *userData)
 Callback invoked when child is about to be removed from aggregate's list of child nodes.
static void predicateCallback (DtVrfObject *vrfObject, DtVrfObjectPredicateEvaluator *predicateEval, void *userData)
 Object predicate callbacks.
static void nodeAddedCallback (DtEntityIdentifier eid, void *userData)
 Callback invoked when node is added to organization hierarchy.
static void nodeRemovedCallback (DtEntityIdentifier eid, void *userData)
 Callback invoked when child is about to be removed from organization hierarchy.
static void objectRemovedCallback (DtVrfObject *vrfObject, void *usr)

Protected Attributes

DtOrganizationViewmyOrganizationView
DtEntityIdentifier myAggregateId
DtOrganizationManagerNodemyAggregateNode
DtVrfObjectManagermyObjectManager
DtVrfObjectPredicatemyPredicate
DtVrfObjectPredicatemyNegatedPredicate
bool myReevaluatePeriodicallyFlag
DtTime myEvaluationPeriod
std::list< DtVrfObject * > myManagedObjectList

Private Member Functions

 DtOrgViewManagedObjectList ()
 DtOrgViewManagedObjectList (DtOrgViewManagedObjectList &orig)
DtOrgViewManagedObjectListoperator= (DtOrgViewManagedObjectList &orig)

Detailed Description

Instances of DtOrgViewManagedObjectList are filtered lists of subordinates for a given aggregate.

The list contains DtVrfObject pointers that match the given predicate. Lists may be configured to be optionally reevaluated at a given interval. The contents of the list can be iterated over just as a standard list.


Member Typedef Documentation


Constructor & Destructor Documentation

Not implemented.

Not implemented.

DtOrgViewManagedObjectList::DtOrgViewManagedObjectList ( DtOrganizationView organizationView,
const DtEntityIdentifier &  aggregateId,
const DtVrfObjectPredicate predicate,
bool  reevaluatePeriodically = false,
DtTime  evaluationPeriod = 0.0 
) [protected]

Constructor Protected to control creation.

call create() instead.

Destructor.


Member Function Documentation

DtOrgViewManagedObjectList& DtOrgViewManagedObjectList::operator= ( DtOrgViewManagedObjectList orig) [private]

Not implemented.

virtual void DtOrgViewManagedObjectList::init ( ) [protected, virtual]

Initializer, called by create() after construction.

static DtOrgViewManagedObjectListPtr DtOrgViewManagedObjectList::create ( DtOrganizationView organizationView,
const DtEntityIdentifier &  aggregateId,
const DtVrfObjectPredicate predicate,
bool  reevaluatePeriodically = false,
DtTime  evaluationPeriod = 0.0 
) [static]

Calls constructor and init().

Returns:
Newly constructed object.
virtual const DtEntityIdentifier& DtOrgViewManagedObjectList::aggregateId ( ) const [virtual]

Entity Identifier of the aggregate whose subordinates are contained within this list.

virtual const DtVrfObjectPredicate& DtOrgViewManagedObjectList::predicate ( ) const [virtual]

Returns the predicate which determines membership in the list.

Returns true if this list get reevaluated.

virtual DtTime DtOrgViewManagedObjectList::evaluationPeriod ( ) const [virtual]

Returns the evaluation interval.

Returns corresponding method from contained myManagedObjectList.

Returns corresponding method from contained myManagedObjectList.

Returns corresponding method from contained myManagedObjectList.

virtual const_iterator DtOrgViewManagedObjectList::end ( ) const [virtual]

Returns corresponding method from contained myManagedObjectList.

virtual size_t DtOrgViewManagedObjectList::size ( ) const [virtual]

Returns corresponding method from contained myManagedObjectList.

virtual void DtOrgViewManagedObjectList::add ( DtVrfObject obj) [protected, virtual]

Add/remove objects to our list of filtered objects.

virtual void DtOrgViewManagedObjectList::remove ( DtVrfObject obj) [protected, virtual]

Add/remove objects to our list of filtered objects.

static void DtOrgViewManagedObjectList::childAddedCallback ( DtEntityIdentifier  eid,
void *  userData 
) [static, protected]

Callback invoked when child is added to aggregate's list of child nodes.

Calls processChildAdded().

static void DtOrgViewManagedObjectList::childRemovedCallback ( DtEntityIdentifier  eid,
void *  userData 
) [static, protected]

Callback invoked when child is about to be removed from aggregate's list of child nodes.

Calls processChildRemoved().

virtual void DtOrgViewManagedObjectList::processChildAdded ( DtEntityIdentifier  eid) [protected, virtual]
virtual void DtOrgViewManagedObjectList::processChildRemoved ( DtEntityIdentifier  eid) [protected, virtual]
static void DtOrgViewManagedObjectList::predicateCallback ( DtVrfObject vrfObject,
DtVrfObjectPredicateEvaluator predicateEval,
void *  userData 
) [static, protected]

Object predicate callbacks.

virtual void DtOrgViewManagedObjectList::processPredicateCallback ( DtVrfObject vrfObject,
DtVrfObjectPredicateEvaluator predicateEval 
) [protected, virtual]
static void DtOrgViewManagedObjectList::nodeAddedCallback ( DtEntityIdentifier  eid,
void *  userData 
) [static, protected]

Callback invoked when node is added to organization hierarchy.

Calls processNodeAdded().

static void DtOrgViewManagedObjectList::nodeRemovedCallback ( DtEntityIdentifier  eid,
void *  userData 
) [static, protected]

Callback invoked when child is about to be removed from organization hierarchy.

Calls processNodeRemoved().

virtual void DtOrgViewManagedObjectList::processNodeAdded ( DtEntityIdentifier  eid) [protected, virtual]
virtual void DtOrgViewManagedObjectList::processNodeRemoved ( DtEntityIdentifier  eid) [protected, virtual]
static void DtOrgViewManagedObjectList::objectRemovedCallback ( DtVrfObject vrfObject,
void *  usr 
) [static, protected]
virtual void DtOrgViewManagedObjectList::processObjectRemoved ( DtVrfObject vrfObject) [protected, virtual]
virtual void DtOrgViewManagedObjectList::registerAggregateNodeCallbacks ( ) [protected, virtual]
virtual void DtOrgViewManagedObjectList::registerOrgViewCallbacks ( ) [protected, virtual]
virtual void DtOrgViewManagedObjectList::registerObjectManagerCallbacks ( ) [protected, virtual]

Non-virtual since called from the destructor.

Non-virtual since called from the destructor.

Non-virtual since called from the destructor.

Non-virtual since called from the destructor.

Non-virtual since called from the destructor.

virtual void DtOrgViewManagedObjectList::populateList ( ) [protected, virtual]

Member Data Documentation

DtEntityIdentifier DtOrgViewManagedObjectList::myAggregateId [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)