VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtOrgViewManagedObjectListManager Class Reference

This class creates and provides DtOrgViewManagedObjectList classes. More...

Public Member Functions

 DtOrgViewManagedObjectListManager (DtOrganizationView &organizationView)
 Constructor.
virtual ~DtOrgViewManagedObjectListManager ()
 Destructor.
virtual
DtOrgViewManagedObjectListConstPtr 
getList (const DtEntityIdentifier &aggregateId, const DtVrfObjectPredicate &predicate, bool reevaluateFlag=false, DtTime evaluationPeriod=0.0)
 Returns a list based on the given predicate which gets evaluated at the given evaluationPeriod.

Protected Types

typedef std::list
< DtBoost::shared_ptr
< DtOrgViewManagedObjectList > > 
DtOrgViewManagedObjectListStdList

Protected Member Functions

virtual void removeExpiredLists ()
 Removes any expired elements from myLists.
virtual void tick ()
 calls removeExpiredLists().
virtual bool registerTickCallback ()
 Registers tickCallback() with DtSimManager. Returns true on success.

Static Protected Member Functions

static void tickCallback (void *usrData)
 Tick callback which is registered with SimManager tick callback.

Protected Attributes

DtOrganizationViewmyOrgView
DtOrgViewManagedObjectListStdList myLists
bool myTickCallbackRegistered

Detailed Description

This class creates and provides DtOrgViewManagedObjectList classes.

A user of this class requests an object list based on an aggregate and a predicate. A shared pointer to a list is returned. This manager may hand out pointers to the same list to multiple callers for efficiency. The lists are all shared pointers, and are deleted when all references to them go out of scope.

Member Typedef Documentation

Constructor & Destructor Documentation

DtOrgViewManagedObjectListManager::DtOrgViewManagedObjectListManager ( DtOrganizationView organizationView)

Constructor.

virtual DtOrgViewManagedObjectListManager::~DtOrgViewManagedObjectListManager ( )
virtual

Destructor.

Member Function Documentation

virtual DtOrgViewManagedObjectListConstPtr DtOrgViewManagedObjectListManager::getList ( const DtEntityIdentifier &  aggregateId,
const DtVrfObjectPredicate predicate,
bool  reevaluateFlag = false,
DtTime  evaluationPeriod = 0.0 
)
virtual

Returns a list based on the given predicate which gets evaluated at the given evaluationPeriod.

Each list returned by getList should be released using releaseList.

virtual void DtOrgViewManagedObjectListManager::removeExpiredLists ( )
protectedvirtual

Removes any expired elements from myLists.

These are elements that no longer have any references outside this class, and have been deleted by shared_ptr.

static void DtOrgViewManagedObjectListManager::tickCallback ( void *  usrData)
staticprotected

Tick callback which is registered with SimManager tick callback.

Calls tick().

virtual void DtOrgViewManagedObjectListManager::tick ( )
protectedvirtual
virtual bool DtOrgViewManagedObjectListManager::registerTickCallback ( )
protectedvirtual

Registers tickCallback() with DtSimManager. Returns true on success.

Member Data Documentation

DtOrganizationView& DtOrgViewManagedObjectListManager::myOrgView
protected
DtOrgViewManagedObjectListStdList DtOrgViewManagedObjectListManager::myLists
protected
bool DtOrgViewManagedObjectListManager::myTickCallbackRegistered
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)