groundManeuverInFormationPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 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/localVertexList.h"
#include "vrfutil/localVectorIterator.h"
#include <vrfobjcore/rwSimObjectReference.h>
#include "vrfobjcore/automotivePSR.h"
#include "vrfutil/rwNLengthUUIDVector.h"


class DT_DLL_vrfobjcore DtGroundManeuverInFormationPSR : public DtVrfProcessStateRepository
{
public:

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

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

   virtual ~DtGroundManeuverInFormationPSR() override;

   DtGroundManeuverInFormationPSR& operator=(const DtGroundManeuverInFormationPSR& orig);

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

   virtual DtString type() const override;

   virtual void setClosestSegmentIndex(int idx);
   virtual int closestSegmentIndex() const;

   virtual void setCurrentMajorRouteIndex(int currentRouteIndex);
   virtual int currentMajorRouteIndex() const;

   virtual void setLeader(const DtUUID& object);
   virtual DtSimObjectReference leader() const;

   virtual void setMajorDirection(DtAutoTransmissionGear direction);
   virtual DtAutoTransmissionGear majorDirection() const;
 
   virtual void setNextMajorRouteIndex(int routeIndex);
   virtual int nextMajorRouteIndex() const;

   virtual void setMajorRoute(const DtUUID& route);
   virtual DtSimObjectReference majorRoute() const;
   virtual void setCreatedOwnMajorRoute(bool);
   virtual bool createdOwnMajorRoute();

   virtual void setMajorRouteVertices(const DtLocalVectorIterator& routeIterator);
   virtual const DtLocalVertexList& majorRouteVertices() const;

   virtual void emptyMajorRouteVertices();

   virtual const DtRwNLengthUUIDVector& followers() const;
   virtual void setFollowers(const DtSimObjectReferenceList&);
 
   virtual double formationLength() const;
   virtual void setFormationLength(double val);
 
   virtual double forwardOffsetFromLeader() const;
   virtual void setForwardOffsetFromLeader(double offset);

   virtual const DtVector& localDestination() const;
   virtual void setLocalDestination(const DtVector& dest);

   virtual DtLocalVectorIterator* majorRouteState() const;

   virtual int currentMajorVertex() const;

   virtual double routeOffsetForward() const;
   virtual void setRouteOffsetForward(double offset);

   virtual double routeOffsetRight() const;
   virtual void setRouteOffsetRight(double offset);

   virtual bool startAtNext() const;
   virtual void setStartAtNext(bool bYes);

   virtual int subtaskId() const;
   virtual void setSubtaskId(int subtaskId);

   virtual void setUseMajorTaskSpeed(const bool value);
   virtual bool useMajorTaskSpeed() const;

   virtual void setMajorTaskSpeed(const double value);
   virtual double majorTaskSpeed() const;

   virtual void setUnitRoute(const DtUUID& object);
   virtual DtSimObjectReference unitRoute() const;

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

public:

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

protected:

   DtRwInt myClosestSegmentIndex;

   DtRwBoolean myCreatedOwnRoute;

   DtRwInt myCurrentMajorRouteIndex;
   DtRwInt myNextMajorRouteIndex;

   DtRwNLengthUUIDVector myFollowers;

   DtRwReal myFormationLength;

   DtRwReal myForwardOffsetFromLeader;

   DtRwSimObjectReference myLeader;

   DtRwVector myLocalDestination;

   DtRwInt myMajorDirection;

   DtRwSimObjectReference myMajorRoute;
   DtLocalVectorIterator* myMajorRouteState;   
   DtLocalVertexList myMajorRouteVertices;

   DtRwInt myMajorRouteCurrentVertex;

   DtRwReal myRouteOffsetRight;

   DtRwReal myRouteOffsetForward;

   DtRwBoolean myStartAtNextVertex;

   DtRwInt mySubtaskId;

   DtRwReal myMajorTaskSpeed;
   DtRwBoolean myUseMajorTaskSpeed;

   DtRwSimObjectReference myUnitRoute;
};