fixedWingFlightPSR.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/vrfobjcoreDefines.h"
#include "vrfobjcore/rwPositionReference.h"
#include <readerWriter/rwReal.h>
#include "readerWriter/rwVector.h"
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwString.h>
#include "vrfutil/localVertexList.h"
#include <readerWriter/rwInt.h>
#include "vrfutil/localVectorIterator.h"
#include <vrfutil/rwUUID.h>
#include <vrfobjcore/rwSimObjectReference.h>

enum DtFixedWingMovementStatus
{
   DtFWTaxiing = 0,  //default if none specified during construction
   DtFWFlying = 1,
   DtFWTakingOff = 2,
   DtFWLanding = 3
};


class DT_DLL_vrfobjcore DtFixedWingFlightPSR : public DtVrfProcessStateRepository
{
public:

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

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

   virtual ~DtFixedWingFlightPSR();

   DtFixedWingFlightPSR& operator=(const DtFixedWingFlightPSR& orig);

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

   virtual DtString type() const;

   virtual void setMaxThrustAccleration(double acceleration);
   virtual double maxThrustAcceleration() const;

   virtual void setNormalizedBodyVelocity(const DtVector& velocity);
   virtual const DtVector& normalizedBodyVelocity() const;

   virtual void setLocalAngularVelocity(double velocity);
   virtual double localAngularVelocity() const;

   virtual void setSpeedRatioSquared(double value);
   virtual double speedRatioSquared() const;

   virtual void setFinishing(bool flag);
   virtual bool isFinishing() const;

   virtual void setApproachingVertex(bool flag);
   virtual bool isApproachingVertex() const;

   virtual void setBanking(bool flag);
   virtual bool isBanking() const;

   virtual void setLastDistanceSquared(double value);
   virtual double lastDistanceSquared() const;

   virtual void setDistanceSquared(double value);
   virtual double distanceSquared() const;

   virtual void setTakeOffDir(const DtVector& takeOffDir);
   virtual const DtVector& takeOffDir() const;

   virtual void setTakeoffDestination(const DtVector& takeOffDir);
   virtual const DtVector& takeoffDestination() const;

   virtual void setLandingDir(const DtVector& landingDir);
   virtual const DtVector& landingDir() const;

   virtual void setEntityToFollow(const DtUUID& objectName);
   virtual DtSimObjectReference entityToFollow() const;

   virtual void setFollowOffsetVector(const DtVector& offset);
   virtual const DtVector& followOffsetVector() const;

   virtual void setLoiterRadius(double radius);
   virtual double loiterRadius() const;

   virtual void setLoiterClockwise(bool flag);
   virtual bool loiterClockwise() const;

   virtual void setLoiterCenter(const DtVector& center);
   virtual const DtVector& loiterCenter() const;

   virtual void setObjectToOrbit(const DtUUID&);

   virtual DtSimObjectReference objectToOrbit() const;

   virtual void setTimeToEndOrbit(double t);
   virtual double timeToEndOrbit() const;

   virtual void setControlPoint(const DtUUID&);

   virtual void setWorldAimingPoint(const DtVector&);

   virtual const DtRwPositionReference& controlPoint();

   virtual DtVector localAimingPoint() const;
   virtual DtVector worldAimingPoint() const;

   virtual bool createdControlPoint() const;

   virtual void setMovementStatus(const DtFixedWingMovementStatus movementStatus);
   virtual const DtFixedWingMovementStatus movementStatus() const;

   virtual void setPreviousAltitude(const double speed);
   virtual const double previousAltitude() const;

   virtual void setFirstWaypoint(const DtUUID&);

   virtual DtSimObjectReference firstWaypoint() const;

   virtual void setSecondWaypoint(const DtUUID&);

   virtual DtSimObjectReference secondWaypoint() const;

   virtual void setReversePatrol(bool reverse);
   virtual bool reversePatrol() const;

   virtual void setRoute(const DtUUID&);

   virtual DtSimObjectReference route() const;

   virtual void setUseFixedPitch(bool);
   virtual bool useFixedPitch() const;

   virtual void setRouteVertices(const DtLocalVectorIterator& routeIterator);
   virtual const DtLocalVertexList& routeVertices() const;

   virtual void emptyRouteVertices();

   virtual DtLocalVectorIterator* routeState() const;

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

   virtual void resetRouteState();
   
   virtual void setMovingToAltitude(bool movingToAlt);
   virtual bool movingToAltitude() const;

   virtual void setMoveToAltitudeValue(double altitude);
   virtual double moveToAltitudeValue() const;

   virtual void setTurningToBeginApproachToRoute(bool);
   virtual bool turningToBeginApproachToRoute() const;


   virtual void setWaitingToSetMovementStatus(bool);
   virtual bool waitingToSetMovementStatus() const;

   virtual void setInitTime(const double initTime);
   virtual DtReal initTime() const;

   virtual void setAltitudeSpecified(const bool isSpecified);
   virtual const bool isAltitudeSpecified() const;


public:

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

protected:
   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;

protected:


   double                           myMaxThrustAcceleration;

   DtRwVector                         myNormalizedBodyVelocity;
   DtRwReal                           myLocalAngularVelocity;
   DtRwReal                           mySpeedRatioSquared;

   DtRwBoolean                        myFinishing;

   DtRwBoolean                        myApproachingVertex;
   DtRwBoolean                        myBanking;
   DtRwReal                           myLastDistanceSquared;
   DtRwReal                           myDistanceSquared;

   DtRwVector                         myTakeOffDir;
   DtRwVector                         myTakeOffDestination;
   DtRwVector                         myLandingDir;

   DtRwSimObjectReference             myEntityToFollow;
   DtRwVector                         myOffsetVector;

   DtRwReal                           myRadius;
   DtRwBoolean                        myClockwise;
   DtRwVector                         myLoiterCircleCenter;

   DtRwSimObjectReference             myObjectToOrbit;

   DtRwReal                           myTimeToEndOrbit;

   DtRwPositionReference              myPositionReference;
   DtRwInt                            myMovementStatus;

   DtRwReal                           myPreviousAltitude;

   DtRwSimObjectReference             myFirstWaypoint;
   DtRwSimObjectReference             mySecondWaypoint;
   DtRwBoolean                        myReverseFlag;

   DtRwSimObjectReference             myRoute;
   DtLocalVectorIterator*             myRouteState;   
   DtLocalVertexList                  myVertices;
   DtRwInt                            myCurrentVertex;

   DtRwBoolean myMovingToAltitude;
   DtRwReal myMoveToAltitudeValue;

   DtRwBoolean myTurningToBeginApproachToRoute;

   DtRwBoolean myUseFixedPitch;
   
   DtRwBoolean myWaitingToSetMovementStatus;

   DtRwReal myInitTime;
   DtRwBoolean myCreatedControlPoint;

   DtRwBoolean myAltitudeSpecified;
};