include/vrfobjcore/remoteComponentAttachmentManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: remoteComponentAttachmentManager.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/
#ifndef DTREMOTECOMPONENTATTACHMENTMANAGER_H_
#define DTREMOTECOMPONENTATTACHMENTMANAGER_H_


#include <vl/globalObjDes.h>

#include <vrfutil/globalObjectDesignatorKey.h>

#include <map>

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/remoteComponentConfigurationBuilder.h"

class DtVrfObjectManager;
class DtFilename;
class DtVrfObject;
class DtRemoteConfigurationMapEntry;
class DtRemoteConfigurationMapper;

class DT_DLL_vrfobjcore DtRemoteComponentAttachmentManager
{
protected:
   DtRemoteComponentAttachmentManager();

public:

   typedef std::map<DtGlobalObjectDesignatorKey,DtGlobalObjectDesignator> RecentArrivalsMap;
   typedef RecentArrivalsMap::iterator ArrivalIterator;
   typedef RecentArrivalsMap::const_iterator const_ArrivalIterator;

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

public:

   DtRemoteComponentAttachmentManager(DtVrfObjectManager *pObjMgr);

   virtual ~DtRemoteComponentAttachmentManager();

public:

   virtual void addRecentArrival(DtVrfObject *pVrfObj);

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

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

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

   virtual void clear();

   virtual DtRemoteConfigurationMapper* createAttachmentRules(const char* pReaderWriterName);

   virtual void clearRecentArrivals();

   virtual EvaluationReadinessState checkReadinessCriteria(DtVrfObject& obj);

   virtual bool checkRejectionCriteria(DtVrfObject& obj);

   virtual void destroyAttachmentRules();

   virtual void evaluateAndAttach(DtVrfObject& obj);

   virtual bool initialize(const DtFilename& fromFile);

   virtual void processRemoveFromArrivals(DtVrfObject* pVrfObj);
   virtual void processRemoveFromArrivals(const DtGlobalObjectDesignator& globalId);

   virtual void resetAllReflectedObjectsToNonVrfSimulated();

   virtual void resetReflectedObjectToNonVrfSimulated(DtVrfObject *pVrfObj);

   virtual void tick();

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

   DtVrfObjectManager* vrfObjectManager();
   const DtVrfObjectManager* vrfObjectManager() const;

public:

   virtual void processVrfObjectToBeRemoved(DtVrfObject* pVrfObject);

   static void vrfObjectToBeRemovedCallback(DtVrfObject* pVrfObject, void* pUsr);

protected:

   virtual void doWork();

protected:

   RecentArrivalsMap myConfirmedAttachments;

   DtTime   myNextTick;

   RecentArrivalsMap myRecentArrivals;

   DtRemoteComponentConfigurationBuilder *pMyRemoteConfigBuilder;

   DtRemoteComponentConfigurationBuilder::CreatorFcn myRemoteConfigBuilderCreatorFcn;

   DtGlobalObjectDesignatorKey myWorkerKey;

   DtTime   myTickRate;

   DtVrfObjectManager   *pMyObjMgr;

   DtRemoteConfigurationMapper *pMyAttachmentRules;


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;}

inline DtVrfObjectManager* DtRemoteComponentAttachmentManager::vrfObjectManager() {return (pMyObjMgr);}
inline const DtVrfObjectManager* DtRemoteComponentAttachmentManager::vrfObjectManager() const {return (pMyObjMgr);}

#endif