VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
DtManagedObjectListManager Class Reference

class DtManagedObjectList: More...

Public Member Functions

 DtManagedObjectListManager (DtVrfObjectManager *objectManager)
 Constructor. More...
 
virtual ~DtManagedObjectListManager ()
 Destructor. More...
 
virtual void init ()
 
DtManagedObjectListConstPtr getList (const DtVrfObjectPredicate &predicate=DtVrfObjectPredicate::nullPredicate(), bool reevaluateFlag=false, DtTime evaluationPeriod=0)
 Returns a list based on the given predicate which gets evaluated at the given evaluationPeriod. More...
 
DtManagedObjectListConstPtr nullList ()
 Return an empty list. More...
 
virtual void printCurrentLists ()
 Prints the string reps for the predicates of the current lists to DtInfo. More...
 

Protected Types

typedef std::list
< DtBoost::weak_ptr
< DtManagedObjectList > > 
DtManagedObjectListStdList
 

Protected Member Functions

 DtManagedObjectListManager ()
 Default constructor; do not call. More...
 
void removeExpiredLists ()
 Removes any expired elements from myLists. More...
 

Protected Attributes

DtVrfObjectManagermyVrfObjectManager
 
tbb::spin_mutex myListsMutex
 
DtManagedObjectListStdList myLists
 
std::list< DtConsoleCommand * > myConsoleCommands
 

Detailed Description

class DtManagedObjectList:

Instances of DtManagedObjectListManager are created and managed by a DtVrfObjectManager. DtManagedObjectLists are automatically recycled and destroyed when they are no longer in use.

Member Typedef Documentation

typedef std::list<DtBoost::weak_ptr<DtManagedObjectList> > DtManagedObjectListManager::DtManagedObjectListStdList
protected

Constructor & Destructor Documentation

DtManagedObjectListManager::DtManagedObjectListManager ( )
protected

Default constructor; do not call.

DtManagedObjectListManager::DtManagedObjectListManager ( DtVrfObjectManager objectManager)

Constructor.

virtual DtManagedObjectListManager::~DtManagedObjectListManager ( )
virtual

Destructor.

Member Function Documentation

virtual void DtManagedObjectListManager::init ( )
virtual
DtManagedObjectListConstPtr DtManagedObjectListManager::getList ( const DtVrfObjectPredicate predicate = DtVrfObjectPredicate::nullPredicate(),
bool  reevaluateFlag = false,
DtTime  evaluationPeriod = 0 
)

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

Lists are returned inside shared pointers. The manager will hand out pointers to the same list to multiple requesters of the same list. The list will be deleted when all shared pointers go out of scope. This function can be called from thread safe components.

DtManagedObjectListConstPtr DtManagedObjectListManager::nullList ( )

Return an empty list.

virtual void DtManagedObjectListManager::printCurrentLists ( )
virtual

Prints the string reps for the predicates of the current lists to DtInfo.

void DtManagedObjectListManager::removeExpiredLists ( )
protected

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.

Member Data Documentation

DtVrfObjectManager* DtManagedObjectListManager::myVrfObjectManager
protected
tbb::spin_mutex DtManagedObjectListManager::myListsMutex
mutableprotected
DtManagedObjectListStdList DtManagedObjectListManager::myLists
protected
std::list<DtConsoleCommand*> DtManagedObjectListManager::myConsoleCommands
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)