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 "vrfobjcore/predicateCallbackManager.h"
#include <vrfutil/rwUUID.h>

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

#include <tbb/spin_mutex.h>

class DtVrfObjectPredicateEvaluator;
class DtManagedObjectList;
class DtVrfCallbackQueue;


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 DtString& listName = "" /* For tracy profiling */);

   virtual void init();

   virtual void init(const std::vector<DtSimObjectReference>&);

public:
   DtManagedObjectList(const DtSimulationServices* simServices,
      const DtVrfObjectPredicate& predicate = 
      DtVrfObjectPredicate::nullPredicate(),
      bool reevaluateFlag = false, DtTime evaluationPeriod = 0,
      const DtString& listName = "" /* For tracy profiling*/);

   DtManagedObjectList(const std::vector<DtSimObjectReference>& subordinates,
      const DtVrfObjectPredicate& predicate,
      const DtString& listName = "" /* For tracy profiling*/);

   static DtManagedObjectListPtr create(
      const DtSimulationServices* objectManager,
      const DtVrfObjectPredicate& predicate = 
      DtVrfObjectPredicate::nullPredicate(),
      bool reevaluatePeriodically = false, DtTime evaluationPeriod = 0.0,
      const DtString& listName = "" /*For tracy profiling*/ );

   virtual ~DtManagedObjectList();

   virtual const DtVrfObjectPredicate& predicate() const;

   virtual void tick(DtVrfCallbackQueue* queue = nullptr);

   virtual bool reevaluateFlag() const ;

   virtual DtTime evaluationPeriod() const;

   typedef std::set<DtSimObjectReference>::iterator iterator;
   typedef std::set<DtSimObjectReference>::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 DtSimObject* find(const DtUUID& entityId) const;
   virtual bool contains(const DtSimObjectReference& simObj) const;

   virtual void invalidate();

   double lastTimeModified() const
   {
      return myLastTimeModified;
   }

   virtual bool isTimeToEvaluate() const;

protected:

   //add & remove using correct hash key type
   virtual void add(DtSimObjectReference obj);
   virtual void remove(const DtSimObject* obj);

   virtual void populateList();

   virtual void simObjectAdded(DtSimObjectReference ref);

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

   virtual bool shouldAdd(DtSimObjectReference ref) const;

protected:
   const DtSimulationServices* mySimulationServices;
   DtVrfObjectPredicate* myPredicate;
   DtVrfObjectPredicate* myNegatedPredicate;
   bool myReevaluateFlag;
   DtTime myEvaluationPeriod;
   DtPredicateCallbackManager myPredicateCallbackManager;
   std::set<DtSimObjectReference> myFilteredObjectList;
   DtString myListName;

   tbb::spin_mutex myMutex;

   struct ConnectionInformation
   {
      boost::signals2::connection removalConnection;
      DtSimObjectReference simObjectReference;
   };

   typedef std::map<unsigned long long, ConnectionInformation > ConnectionMap;
   ConnectionMap myConnectionMap;

   boost::signals2::scoped_connection mySimObjectAddedConnection;

   double myLastTimeModified;
   mutable double myNextEvaluationTime = 0.;
};