managedObjectList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfobjcore/vrfObjectPredicate.h"

#include <vlutil/vlConfig.h>
#include <list>
#include <vlutil/vlSmartPointers.h>
#include <vlutil/vlTime.h>

class DtVrfObjectManager;
class DtVrfObjectPredicateEvaluator;
class DtManagedObjectList;
class DtVrfObject;
class DtEntityIdentifier;

typedef DtBoost::shared_ptr<DtManagedObjectList> DtManagedObjectListPtr;
typedef DtBoost::shared_ptr<const DtManagedObjectList> DtManagedObjectListConstPtr;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtManagedObjectList
{
private:
   DtManagedObjectList(DtManagedObjectList& orig);
   DtManagedObjectList& operator=(DtManagedObjectList& orig);

protected:
   DtManagedObjectList(const DtVrfObjectManager* objectManager,
      const DtVrfObjectPredicate& predicate = 
      DtVrfObjectPredicate::nullPredicate(),
      bool reevaluateFlag = false, DtTime evaluationPeriod = 0);

   virtual void init();

   DtManagedObjectList();

public:
   static DtManagedObjectListPtr create(
      const DtVrfObjectManager* objectManager,
      const DtVrfObjectPredicate& predicate = 
      DtVrfObjectPredicate::nullPredicate(),
      bool reevaluatePeriodically = false, DtTime evaluationPeriod = 0.0);

   virtual ~DtManagedObjectList();

   virtual const DtVrfObjectPredicate& predicate() const;

   virtual bool reevaluateFlag() const ;

   virtual DtTime evaluationPeriod() const;

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

   static DtManagedObjectListPtr nullList();

   virtual iterator begin();
   virtual const_iterator begin() const;
   virtual iterator end();
   virtual const_iterator end() const;
   virtual size_t size() const;

   virtual const DtVrfObject* find(const DtEntityIdentifier& entityId) const;

   virtual void invalidate();


protected:
   //add & remove using correct hash key type
   virtual void add(const DtVrfObject* obj);
   virtual void remove(const DtVrfObject* obj);

   virtual void populateList();

   static void objectAddedCallback(const DtVrfObject * vrfObject, void * usr);
   virtual void processObjectAdded(const DtVrfObject * vrfObject);
   static void objectRemovedCallback(const DtVrfObject * vrfObject, void * usr);
   virtual void processObjectRemoved(const DtVrfObject * vrfObject);

   static void predicateCallback(const DtVrfObject* vrfObject, 
      DtVrfObjectPredicateEvaluator* predicateEval, void* userData);
   virtual void processPredicateCallback(const DtVrfObject* vrfObject, 
      DtVrfObjectPredicateEvaluator* predicateEval);

protected:
   const DtVrfObjectManager* myObjectManager;
   DtVrfObjectPredicate* myPredicate;
   DtVrfObjectPredicate* myNegatedPredicate;
   bool myReevaluateFlag;
   DtTime myEvaluationPeriod;
   std::list<const DtVrfObject*> myFilteredObjectList;
};