vrfEmbarkationPSR.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/vrfProcessStateRepository.h"
#include "vrfobjcore/vrfObjectReference.h"
#include <readerWriter/rwInt.h>
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwString.h>
#include "readerWriter/rwVector.h"
#include "vrfutil/rwTaitBryan.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfutil/rwVectorList.h"
#include <vrfutil/rwUUID.h>


#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrftasks/radioMessageTypes.h"
class DT_DLL_vrfobjcore DtVrfEmbarkationPSR : public DtVrfProcessStateRepository
{
public:
   enum DtEmbarkationControllerState
   {
      DtIdle               = 0,
      DtMoveToEgress       = 5,
      DtMovingToEgress,
      DtDisembark,
      DtMoveToIngress,
      DtMovingToIngress,
      DtMoveToEmbarkationPoint,
      DtMovingToEmbarkationPoint,
      DtAtEmbarkationPoint,
      DtWaitingToStop,
      DtStoppedAtEmbarkedPoint,
      DtWaitingForEmbarkationInformation,
      DtWaitingForDisembarkationInformation,
      DtMoveToFinalDestination,
      DtMovingToFinalDestination,
      DtCompletingTask,
      DtPerformingEmbarkTechnique,
      DtPerformingDisembarkTechnique,
      DtSendMoveAlongToEgressTask
   };

public:

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

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

   virtual ~DtVrfEmbarkationPSR();

   DtVrfEmbarkationPSR& operator=(const DtVrfEmbarkationPSR& orig);

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

   virtual DtString type() const;

   virtual void setEmbarkationState(DtEmbarkationControllerState state);
   virtual DtEmbarkationControllerState embarkationState() const;

   virtual void setEmbarkationInformation(const DtUUID& parent,
      bool useEmbarkationOverride = false, const DtVector& embarkationOverridePosition = DtVector::zero(),
      int embarkInSlot = -1, bool chooseAnyIfSlotTaken = true);

   virtual void getEmbarkationInformation(DtRwVrfObjectReference& parent, bool& useEmbarkationOverride,
      DtVector& embarkationOverridePosition, int& embarkInSlot, bool& chooseAnyIfSlotTaken);
   virtual const DtRwVrfObjectReference& embarkationParent() const;
   virtual bool embarkationLocationOverride() const;
   virtual const DtVector& embarkationLocationOverridePosition() const;
   virtual int embarkInSlot() const;
   virtual bool chooseAnyAvailableSlotIfTaken() const;

   virtual void setControlPoint(const DtUUID&);

   virtual const DtRwVrfObjectReference& controlPoint() const;
   virtual DtRwVrfObjectReference& controlPoint();

   virtual void setPath(const std::vector<DtVector>&);
   virtual const std::vector<DtVector>& path() const;

   virtual void setEmbarkedAppearance(int);
   virtual int embarkedAppearance() const;

   virtual void setEmbarkedAnimation(const DtString&);
   virtual const DtString& embarkedAnimation() const;

   virtual void setSlotName(const DtString&);
   virtual const DtString& slotName() const;

   virtual void setSlotType(const DtString&);
   virtual const DtString& slotType() const;

   virtual void setPublishLoadPoints(bool);
   virtual bool publishLoadPoints() const;

   virtual void setOnGroundBeforeDisembark(bool);
   virtual bool onGroundBeforeDisembark() const;

   virtual void setEmbarkedOrientation(const DtTaitBryan&);
   virtual const DtTaitBryan& embarkedOrientation() const;

   virtual void clearEmbarkationInformation();

   virtual void setJumpToLocation(bool b);
   virtual bool jumpToLocation() const;

   virtual void setTurnToHeading(bool b);
   virtual bool turnToHeading() const;

   virtual void setOrientOnIngress(bool b);
   virtual bool orientOnIngress() const;

   virtual void setInvisibleWhenEmbarked(bool b);
   virtual bool invisibleWhenEmbarked() const;

   virtual void setWasInvisibleBeforeEmbark(bool b);
   virtual bool wasInvisibleBeforeEmbark() const;

   virtual void setExitPosition(const DtVector&);
   virtual const DtVector& exitPosition() const;

   virtual void setTechnique(const DtString&);
   virtual const DtString& technique() const;

   virtual void setCurrentSubordinateTask(const DtSimTaskMessageType&);
   virtual DtSimTaskMessageType currentSubordinateTask() const;

   virtual void addTaskedSubordinate(const DtUUID& name);
   virtual bool removeTaskedSubordinate(const DtUUID& name);
   virtual const DtRwVrfObjectReferenceList& taskedSubordinates() const;
   virtual DtRwVrfObjectReferenceList& taskedSubordinates();
   virtual void clearTaskedSubordinates();


   virtual void prePutSelf();
   virtual void postGetSelf();

   virtual DtString stateString(DtEmbarkationControllerState s);
public:

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

protected:

   DtRwInt        myEmbarkationState;
   DtRwVrfObjectReference     myControlPoint;
   DtRwVrfObjectReference     myEmbarkationParent;
   DtRwBoolean    myEmbarkationLocationOverride;
   DtRwVector     myEmbarkationLocationOverridePosition;
   DtRwVector     myExitPosition;
   DtRwInt        myEmbarkedAppearance;
   DtRwString     myEmbarkedAnimation;
   DtRwString     mySlotName;
   DtRwString     mySlotType;
   DtRwInt        myEmbarkInSlot;
   DtRwBoolean    myChooseAnyAvailableIfSlotTaken;
   DtRwTaitBryan  myEmbarkedOrientation;
   DtRwBoolean    myPublishLoadPoints;
   DtRwBoolean    myOnGroundBeforeDisembark;
   DtRwBoolean    myJumpToLocation;
   DtRwBoolean    myTurnToHeading;
   DtRwBoolean    myOrientOnIngress;
   DtRwBoolean    myWasInvisibleBeforeEmbark;
   DtRwBoolean    myInvisibleWhenEmbarked;
   DtRwString     myTechnique;
   DtRwOffsetVectorList myRwPath;
   std::vector<DtVector> myPath;

   DtRwVrfObjectReferenceList myTaskedSubordinates;
   DtRwString myCurrentSubordinateTask;
};