railMovementControllerPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 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/rwInt.h>
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwString.h>
#include "readerWriter/rwVector.h"
#include <vrfutil/rwUUID.h>
#include <vrfobjcore/rwSimObjectReference.h>


enum DtRailMovementState
{
   DtNoMovement = 0,
   DtMovementAlongSegment,
   DtMovementApproachingTurn,
   DtMovementTurning,
   DtMovementApproachingSwitchLanes,
   DtMovementSwitchLanes,
   DtMovementPassing,
   DtMovementRerouteToNextSegment,
   DtMovementApproachingDestination,
   DtMovementStop
};
class DT_DLL_vrfobjcore DtRailMovementControllerPSR : public DtVrfProcessStateRepository
{
public:

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

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

   virtual ~DtRailMovementControllerPSR() override;

   DtRailMovementControllerPSR& operator=(const DtRailMovementControllerPSR& orig);

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

   virtual DtString type() const override;

   virtual void setCurrentMovementState(DtRailMovementState state);
   virtual DtRailMovementState currentMovementState() const;

   virtual void setUseHighFidelityGroundClamping(bool yesOrNo);
   virtual bool useHighFidelityGroundClamping() const;

   virtual void resetSegmentIndex(); 
   virtual void incrementSegmentIndex();
   virtual const int segmentIndex() const;
   virtual void setSegmentIndex(const int);

   virtual double positionAlongLane() const;
   virtual void setPositionAlongLane(const double p);

   virtual double speedAlongLane() const;
   virtual void setSpeedAlongLane(const double s);

   virtual double accelerationAlongLane()const;
   virtual void setAccelerationAlongLane(const double a);

   virtual double offsetFromLaneCenterline() const;
   virtual void setOffsetFromLaneCenterline(const double offset);

   virtual double laneHeading() const;
   virtual void setLaneHeading(const double heading);

   virtual double laneChangeWidth() const;
   virtual void setLaneChangeWidth(const double f);

   
   virtual void setCurrentLanePosition(const int lane);
   virtual const int currentLanePosition() const;

   virtual void setCurrentLaneNumber(const int lane);
   virtual const int currentLaneNumber() const;

   virtual void setPassingLanePosition(const int lane);

   virtual const int passingLanePosition() const;

   virtual void setTurning(bool turn);
   virtual bool turning() const;

   virtual void setAllowPassing(bool canPass);
   virtual bool allowPassing() const;

   virtual void setPassing(bool pass);
   virtual bool passing() const;

   virtual void setAvoidingCollision(bool avoid);
   virtual bool avoidingCollision() const;

   virtual void setNeedSwitchLanes(bool switchLane);
   virtual bool needSwitchLanes() const;
   
   virtual void setIsAcquiringLane(bool isAcquiring);
   virtual bool isAcquiringLane() const;

   virtual void setConvoyTargetSpecified(bool following);
   virtual bool convoyTargetSpecified() const;

   virtual void setConvoyFollowTarget(const DtUUID&);

   virtual DtSimObjectReference convoyFollowTarget() const;

   virtual void setConvoyFollowDistance(const double dist);
   virtual const double convoyFollowDistance() const;

   void setConvoyUseCatchUpSpeed(const bool useCatchUpSpeed);
   const bool convoyUseCatchUpSpeed() const;
   

   virtual const double maxFollowThreshold() const;
   virtual void setMaxFollowThreshold(const double threshold);

   virtual bool useBreakdownLane() const;
   virtual void setUseBreakdownLane(const bool bYes);

   virtual bool useOpposingLane() const;
   virtual void setUseOpposingLane(const bool bYes);
 
   virtual void setUseTaskSpeed(const bool value);
   virtual bool useTaskSpeed() const;

   virtual void setTaskSpeed(const double value);
   virtual double taskSpeed() const;

public:

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

protected:

   DtRwInt        myCurrentMovementState;

   DtRwBoolean myUseHighFidelityGroundClamping;

   DtRwInt  mySegmentIndex; 

   DtRwReal myPositionAlongLane;

   DtRwReal mySpeedAlongLane;
   DtRwReal myAccelerationAlongLane;

   DtRwReal myLateralOffset;

   DtRwReal myLaneHeading;

   DtRwReal myLaneChangeWidth;
   
   DtRwInt  myCurrentLanePosition; 

   DtRwInt  myPassingLanePosition;

   DtRwBoolean  myTurning;

   DtRwBoolean  myAllowPassing;

   DtRwBoolean  myPassing;

   DtRwBoolean  myAvoidingCollision;

   DtRwBoolean    myNeedToSwitchLanes;

   DtRwBoolean myIsAcquiringLane;

   DtRwBoolean     myConvoyTargetSpecified;

   DtRwSimObjectReference     myConvoyFollowTarget;

   DtRwReal     myConvoyFollowDistance;

   DtRwBoolean  myConvoyUseCatchUpSpeed;

   DtRwReal     myMaxFollowThreshold;

   DtRwBoolean myUsingBreakdownLane;
   DtRwBoolean myUsingOpposingLane;

   DtRwReal myTaskSpeed;
   DtRwBoolean myUseTaskSpeed;
};