include/vrfobjcore/aggregateMoveAlongPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: aggregateMoveAlongPSR.h,v $ $Revision: 1.11 $ $State: Exp $
*******************************************************************************/



#ifndef DtAggregateMoveAlongPSR_H_
#define DtAggregateMoveAlongPSR_H_

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/processSR.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwReal.h"
#include "vrfobjcore/promotionIdObjectNameInfo.h"
#include "vrfutil/rwStringList.h"
#include "vrfutil/rwBoolean.h"

#include <set>

class DT_DLL_vrfobjcore DtAggregateMoveAlongPSR : public DtVrfProcessStateRepository
{
   typedef std::map<DtString, int> DtObjectNamePromotionIdMap;
   typedef std::map<int, DtString> DtPromotionIdObjectNameMap;

public:

   DtAggregateMoveAlongPSR(DtVrfObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtAggregateMoveAlongPSR(const DtAggregateMoveAlongPSR& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   virtual ~DtAggregateMoveAlongPSR();

   DtAggregateMoveAlongPSR& operator=(const DtAggregateMoveAlongPSR& orig);

   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual DtString type() const;

   virtual void setRouteName(const DtString& routeName);
   virtual const DtString& routeName() const;

   virtual void setTimeToNextMaintainFormationTick(DtTime simTime);
   virtual DtTime timeToNextMaintainFormationTick() const;

   virtual DtString lookupRouteName(int promotionId) const;

   virtual DtString lookupRouteName(const DtString& objectName) const;

   virtual void clearPromotionIdRouteNameList();

   virtual void addPromotionIdRouteNameEntry(int promotionId, 
      const DtString& routeName);

   virtual const DtPromotionIdObjectNameMap& promotionIdRouteNameList() const;

   virtual void addTaskedSubordinateNamePromotionIdEntry(
      const DtString& objectName, int promotionId);

   virtual void removeTaskedSubordinateName(const DtString& objectName);

   virtual bool isATaskedSubordinate(const DtString& objectName);

   virtual void removeRoute(const DtString& routeName);

   virtual void clearTaskSubordinateNames();

   virtual bool taskedSubordinateNamesEmpty() const;

   virtual void setMovingToRoute(bool trueOrFalse);
   virtual bool movingToRoute() const;

   virtual const DtObjectNamePromotionIdMap& taskedSubordinateNames() const;

   virtual void setRouteIsDiscovered(bool value);
   virtual bool routeIsDiscovered() const;

   virtual void putSelf(FILE *fp, int indentLevel = 0, 
      bool writeUnspecified = false, 
      const DtFilename& path = DtReaderWriter::appPath());

   virtual void getSelf(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);  

   static DtVrfProcessStateRepository* creator (const DtString& rwName,
      DtVrfObject* vrfObject, DtReaderWriterRegistry* parentRegistry);

protected:

   DtPromotionIdObjectNameMap myPromotionIndexRouteNameMap;

   DtObjectNamePromotionIdMap myCurrentlyTaskedSubordinateNames;

   DtRwString myRouteName;

   DtPromotionIdObjectNameList myPromotionIdRouteNameList;

   DtPromotionIdObjectNameList myPromotionIdEntityNameList;

   DtRwReal myTimeToNextMaintainFormationTick;

   DtRwBoolean myMovingToRoute;

   DtRwBoolean myRouteIsDiscovered;
};

#endif