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 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...

Public Types

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

Public Member Functions

virtual ~DtOrgViewManagedObjectList ()
 Destructor. More...
 
virtual const DtUUIDaggregateId () const
 UUID of the aggregate whose subordinates are contained within this list. More...
 
virtual const
DtVrfObjectPredicate
predicate () const
 Returns the predicate which determines membership in the list. More...
 
virtual bool reevaluatePeriodically () const
 Returns true if this list get reevaluated. More...
 
virtual DtTime evaluationPeriod () const
 Returns the evaluation interval. More...
 
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 DtUUID &aggregate, const DtVrfObjectPredicate &predicate, bool reevaluatePeriodically=false, DtTime evaluationPeriod=0.0)
 Calls constructor and init(). More...
 
static
DtOrgViewManagedObjectListPtr 
nullList (DtOrganizationView &)
 

Protected Member Functions

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

Static Protected Member Functions

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

Protected Attributes

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

Private Member Functions

 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

DtOrgViewManagedObjectList::DtOrgViewManagedObjectList ( DtOrgViewManagedObjectList orig)
private

Not implemented.

DtOrgViewManagedObjectList::DtOrgViewManagedObjectList ( DtOrganizationView organizationView,
const DtUUID aggregate,
const DtVrfObjectPredicate predicate,
bool  reevaluatePeriodically = false,
DtTime  evaluationPeriod = 0.0 
)
protected

Constructor Protected to control creation.

call create() instead.

DtOrgViewManagedObjectList::DtOrgViewManagedObjectList ( DtOrganizationView )
protected
virtual DtOrgViewManagedObjectList::~DtOrgViewManagedObjectList ( )
virtual

Destructor.

Member Function Documentation

DtOrgViewManagedObjectList& DtOrgViewManagedObjectList::operator= ( DtOrgViewManagedObjectList orig)
private
virtual void DtOrgViewManagedObjectList::init ( )
protectedvirtual

Initializer, called by create() after construction.

static DtOrgViewManagedObjectListPtr DtOrgViewManagedObjectList::create ( DtOrganizationView organizationView,
const DtUUID aggregate,
const DtVrfObjectPredicate predicate,
bool  reevaluatePeriodically = false,
DtTime  evaluationPeriod = 0.0 
)
static

Calls constructor and init().

Returns
Newly constructed object.
static DtOrgViewManagedObjectListPtr DtOrgViewManagedObjectList::nullList ( DtOrganizationView )
static
virtual const DtUUID& DtOrgViewManagedObjectList::aggregateId ( ) const
virtual

UUID 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.

virtual bool DtOrgViewManagedObjectList::reevaluatePeriodically ( ) const
virtual

Returns true if this list get reevaluated.

virtual DtTime DtOrgViewManagedObjectList::evaluationPeriod ( ) const
virtual

Returns the evaluation interval.

virtual iterator DtOrgViewManagedObjectList::begin ( )
virtual

Returns corresponding method from contained myManagedObjectList.

virtual const_iterator DtOrgViewManagedObjectList::begin ( ) const
virtual
virtual iterator DtOrgViewManagedObjectList::end ( )
virtual
virtual const_iterator DtOrgViewManagedObjectList::end ( ) const
virtual
virtual size_t DtOrgViewManagedObjectList::size ( ) const
virtual
virtual void DtOrgViewManagedObjectList::add ( const DtVrfObject obj)
protectedvirtual

Add/remove objects to our list of filtered objects.

virtual void DtOrgViewManagedObjectList::remove ( const DtVrfObject obj)
protectedvirtual
static void DtOrgViewManagedObjectList::childAddedCallback ( const DtUUID superior,
const DtUUID eid,
void *  userData 
)
staticprotected

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

Calls processChildAdded().

static void DtOrgViewManagedObjectList::childRemovedCallback ( const DtUUID superior,
const DtUUID eid,
void *  userData 
)
staticprotected

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

Calls processChildRemoved().

virtual void DtOrgViewManagedObjectList::processChildAdded ( const DtUUID superior,
const DtUUID eid 
)
protectedvirtual
virtual void DtOrgViewManagedObjectList::processChildRemoved ( const DtUUID superior,
const DtUUID eid 
)
protectedvirtual
static void DtOrgViewManagedObjectList::predicateCallback ( const DtVrfObject vrfObject,
DtVrfObjectPredicateEvaluator predicateEval,
void *  userData 
)
staticprotected

Object predicate callbacks.

virtual void DtOrgViewManagedObjectList::processPredicateCallback ( const DtVrfObject vrfObject,
DtVrfObjectPredicateEvaluator predicateEval 
)
protectedvirtual
static void DtOrgViewManagedObjectList::nodeAddedCallback ( const DtUUID eid,
void *  userData 
)
staticprotected

Callback invoked when node is added to organization hierarchy.

Calls processNodeAdded().

static void DtOrgViewManagedObjectList::nodeRemovedCallback ( const DtUUID eid,
void *  userData 
)
staticprotected

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

Calls processNodeRemoved().

virtual void DtOrgViewManagedObjectList::processNodeAdded ( const DtUUID eid)
protectedvirtual
virtual void DtOrgViewManagedObjectList::processNodeRemoved ( const DtUUID eid)
protectedvirtual
static void DtOrgViewManagedObjectList::objectRemovedCallback ( const DtVrfObject vrfObject,
void *  usr 
)
staticprotected
virtual void DtOrgViewManagedObjectList::processObjectRemoved ( const DtVrfObject vrfObject)
protectedvirtual
static void DtOrgViewManagedObjectList::objectUUIDChangedCallback ( const DtVrfObjectUUIDChangedCallbackInfo info,
void *  usr 
)
staticprotected
virtual void DtOrgViewManagedObjectList::processObjectUUIDChanged ( const DtVrfObjectUUIDChangedCallbackInfo info)
protectedvirtual
virtual void DtOrgViewManagedObjectList::registerAggregateNodeCallbacks ( )
protectedvirtual
virtual void DtOrgViewManagedObjectList::registerOrgViewCallbacks ( )
protectedvirtual
virtual void DtOrgViewManagedObjectList::registerObjectManagerCallbacks ( )
protectedvirtual
void DtOrgViewManagedObjectList::unregisterAggregateNodeCallbacks ( )
protected

Non-virtual since called from the destructor.

void DtOrgViewManagedObjectList::unregisterOrgViewCallbacks ( )
protected
void DtOrgViewManagedObjectList::unregisterPredicateCallbacksForAllChildren ( )
protected
void DtOrgViewManagedObjectList::unregisterPredicateCallbacks ( const DtVrfObject object)
protected
void DtOrgViewManagedObjectList::unregisterObjectManagerCallbacks ( )
protected
virtual void DtOrgViewManagedObjectList::populateList ( )
protectedvirtual

Member Data Documentation

DtOrganizationView& DtOrgViewManagedObjectList::myOrganizationView
protected
DtUUID DtOrgViewManagedObjectList::myAggregateId
protected
DtOrganizationManagerNode* DtOrgViewManagedObjectList::myAggregateNode
protected
const DtVrfObjectManager* DtOrgViewManagedObjectList::myObjectManager
protected
DtVrfObjectPredicate* DtOrgViewManagedObjectList::myPredicate
protected
DtVrfObjectPredicate* DtOrgViewManagedObjectList::myNegatedPredicate
protected
bool DtOrgViewManagedObjectList::myReevaluatePeriodicallyFlag
protected
DtTime DtOrgViewManagedObjectList::myEvaluationPeriod
protected
std::list<const DtVrfObject*> DtOrgViewManagedObjectList::myManagedObjectList
protected

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)