convoyPSR.h

Go to the documentation of this file.

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


#pragma once
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/vrfProcessStateRepository.h"
#include "vrfobjcore/simObject.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/rwString.h>
#include "vrfobjcore/promotionIdUUIDInformation.h"
#include "vrfutil/railSegment.h"
#include "vrfutil/rwRailSegment.h"
#include "readerWriter/rwVector.h"
#include <set>
#include "vrftasks/railMoveAlongTask.h"
#include "vrftasks/moveToLocationTasks.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>
#include <vrfobjcore/rwSimObjectReference.h>
#include <vrfobjcore/simObjectReferenceList.h>

class DT_DLL_vrfobjcore DtConvoyPSR : public DtVrfProcessStateRepository
{

public:
   DtConvoyPSR(DtLocalObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

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

   virtual ~DtConvoyPSR();

   DtConvoyPSR& operator=(const DtConvoyPSR& orig);

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

   virtual DtString type() const;

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

   virtual void setPathPlanFlag(bool flag);
   virtual bool pathPlanFlag() const;

   virtual void setConvoyPhase(const DtString& phase);
   virtual const DtString& convoyPhase() const;

   virtual void setDestination(const DtUUID& destination);
   virtual DtSimObjectReference destination() const;

   virtual const DtRwSimObjectReferenceList& subordinates() const;
   virtual void addSubordinate(const DtUUID& subordinate);
   virtual void removeSubordinate(const DtUUID& subordinate);
   virtual bool isASubordinate(const DtUUID& subordinate) const;
   virtual bool isSubordinatesEmpty() const;
   virtual void clearSubordinates();

   virtual void addAwaitingTaskSubordinate(const DtUUID& subordinate);
   virtual void removeAwaitingTaskSubordinate(const DtUUID& subordinate);
   virtual DtSimObjectReference lastTaskedSubordinate() const;
   virtual DtSimObjectReference firstAwaitingTaskSubordinate() const;
   virtual void clearAwaitingTaskSubordinates();
   virtual bool isAwaitingTaskSubordinatesEmpty() const;

   virtual void setAssemblyPoint(const DtVector& assemblyPoint);
   virtual const DtVector& assemblyPoint() const;

   virtual void setConvoyLeader(const DtUUID& name);
   virtual DtSimObjectReference convoyLeader() const;

   virtual void setLeadOnDistance(const float distance);
   virtual const float leadOnDistance() const;

   virtual void setFollowDistance(const float distance);
   virtual const float followDistance() const;

   virtual void setLastGeneratedEntryRail(const DtRwRailSegment& entryRail);
   virtual DtRwRailSegment* lastGeneratedEntryRail();

   virtual void setLastOrderedSpeed(const float speed);
   virtual const float lastOrderedSpeed() const;

   virtual void setStopIfEntityDestroyed(bool);
   virtual bool stopIfEntityDestroyed() const;

   virtual void addRailSegment(const DtRailSegment& railSegment);
   virtual void addRailSegment(const DtRwRailSegment& railSegment);
   virtual void addRailSegment(const DtRwRailSegment* railSegment);
   virtual void addRailSegmentToFront(const DtRwRailSegment* railSegment);
   virtual DtRwRailSegment removeRailSegmentFromFront();
   virtual void setRailSegments(const DtRwRailSegmentList& segments);
   virtual void setRailSegments(const DtRailSegmentList& segments);
   virtual const DtRwRailSegmentList& railSegmentList() const;
   virtual void clearRailSegments();

   virtual DtRailSegmentList* railSegments();

protected:
   void clearTempRailList();

protected:
   DtRwBoolean myPathPlanFlag;
   DtRwString myConvoyPhase;
   DtRwSimObjectReference myDestination;
   DtRwVector myAssemblyPoint;
   DtRwSimObjectReference myConvoyLeader;
   DtRwSimObjectReference myLastTaskedSubordinate;
   DtRwReal myLeadOnDistance;
   DtRwReal myFollowDistance;
   DtRwReal myLastOrderedSpeed;
   DtRwSimObjectReferenceList mySubordinates;
   DtRwSimObjectReferenceList myAwaitingTaskSubordinates;
   DtRwRailSegmentList myRailSegments;
   DtRwRailSegment myLastGeneratedEntryRail;
   DtRailSegmentList* myTempListPtr;
   DtRwBoolean myStopIfEntityDestroyed;
   bool myRegenerateTempRailList;
};