remoteComponentAttachmentManager.h

Go to the documentation of this file.

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

#pragma once



#include <vrfutil/globalObjectDesignatorKey.h>

#include <set>

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/remoteComponentConfigurationBuilder.h"
#include "vrfobjcore/simObjectReference.h"
#include "vrfobjcore/simObjectReferenceList.h"
#include "vrfutil/rwUUID.h"
#include <tbb/spin_mutex.h>
#include <boost/signals2.hpp>

class DtLocalObjectManager;
class DtFilename;
class DtRemoteConfigurationMapEntry;
class DtRemoteConfigurationMapper;

class DT_DLL_vrfobjcore DtRemoteComponentAttachmentManager
{
protected:
   DtRemoteComponentAttachmentManager();

public:

   typedef DtRemoteComponentConfigurationBuilder* (*CreatorFcn)(DtRemoteComponentAttachmentManager*, DtLocalObjectManager*);

   typedef std::map<DtUUID, boost::signals2::connection> RecentArrivalsMap;
   typedef RecentArrivalsMap::iterator ArrivalIterator;
   typedef RecentArrivalsMap::const_iterator const_ArrivalIterator;

   enum EvaluationReadinessState
   {
      Remove = -1,
      NotReady = 0,
      Ready
   };

public:

   DtRemoteComponentAttachmentManager(DtLocalObjectManager *pObjMgr);

   virtual ~DtRemoteComponentAttachmentManager();

public:

   virtual void addRecentArrival(DtSimObjectReference);

   virtual void attach(const DtRemoteConfigurationMapEntry& entry,
      DtSimObjectReference obj);

   virtual bool isRemoteComponentAttachment(const DtUUID&) const;

   virtual DtRemoteConfigurationMapper* attachmentRules();
   virtual const DtRemoteConfigurationMapper* attachmentRules() const;

   DtRemoteComponentConfigurationBuilder::CreatorFcn builderCreatorFcn();
   void setBuilderCreatorFcn(DtRemoteComponentConfigurationBuilder::CreatorFcn fcn);

   virtual void clear();

   virtual void setRemoteAttachmentBalancingScheme(const DtString& scheme, const DtString& userData);

   virtual DtRemoteConfigurationMapper* createAttachmentRules(const char* pReaderWriterName);

   virtual void clearRecentArrivals();

   virtual EvaluationReadinessState checkReadinessCriteria(DtSimObjectReference obj) const;

   virtual bool checkRejectionCriteria(DtSimObjectReference obj) const;

   virtual void destroyAttachmentRules();

   virtual void evaluateAndAttach(DtSimObjectReference obj);

   virtual bool initialize(const DtFilename& fromFile);

   virtual void processRemoveFromArrivals(const DtUUID& uuid);

   virtual void resetAllReflectedObjectsToNonVrfSimulated();

   virtual void resetReflectedObjectToNonVrfSimulated(const DtUUID& pVrfObj);

   virtual void tick();

   DtTime tickRate() const;
   void setTickRate(DtTime interval);

   virtual bool passesAttachmentScheme(DtSimObjectReference ref) const;

public:

   virtual void processVrfObjectToBeRemoved(const DtSimObject* pVrfObject);

protected:

   virtual void doWork();

protected:

   RecentArrivalsMap myConfirmedAttachments;

   DtTime   myNextTick;

   DtSimObjectReferenceList myRecentArrivals;

   DtRemoteComponentConfigurationBuilder *myRemoteConfigBuilder;

   DtRemoteComponentConfigurationBuilder::CreatorFcn myRemoteConfigBuilderCreatorFcn;

   DtRwUUID myWorkerKey;

   DtTime   myTickRate;

   DtLocalObjectManager   *myObjectManager;

   DtRemoteConfigurationMapper *myAttachmentRules;

   tbb::spin_mutex myRecentArrivalsMutex;

   boost::signals2::scoped_connection mySimObjectAddedConnection;

   DtString myRemoteComponentAttachmentScheme;
   DtString myRemoteComponentAttachmentSchemeData;

private:
   DtRemoteComponentAttachmentManager(DtRemoteComponentAttachmentManager&);
   const DtRemoteComponentAttachmentManager& operator=(const DtRemoteComponentAttachmentManager&);
};

inline DtRemoteComponentConfigurationBuilder::CreatorFcn DtRemoteComponentAttachmentManager::builderCreatorFcn()
{
   return (myRemoteConfigBuilderCreatorFcn);
}

inline void DtRemoteComponentAttachmentManager::setBuilderCreatorFcn(DtRemoteComponentConfigurationBuilder::CreatorFcn fcn)
{
   myRemoteConfigBuilderCreatorFcn = fcn;
}

inline DtTime DtRemoteComponentAttachmentManager::tickRate() const {return (myTickRate);}
inline void DtRemoteComponentAttachmentManager::setTickRate(DtTime interval) {myTickRate = interval;}