rotaryWingPilotDescriptor.h

Go to the documentation of this file.

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



#include "vrfobjparam/rotaryWingTaskDescriptor.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>
#include "vrfutil/1DRegularTableFn.h"
#include "vrfutil/rwResource.h"

class Dt1DRegularTableFn;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtRotaryWingPilotDescriptor : public DtRotaryWingTaskDescriptor
{
public:
   DtRotaryWingPilotDescriptor(const DtString& name, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   DtRotaryWingPilotDescriptor(const DtRotaryWingPilotDescriptor & 
      orig, DtReaderWriterRegistry * parentRegistry = 0);
   
   DtRotaryWingPilotDescriptor & operator=(const 
      DtRotaryWingPilotDescriptor & orig);
   
   virtual ~DtRotaryWingPilotDescriptor() override;

   virtual DtString type() const override;

   virtual DtComponentDescriptor * clone(DtReaderWriterRegistry* parentRegistry = 0) const override;

   virtual const DtEntityType& fuelType() const;
   virtual void setFuelType(const DtEntityType& fuelType);

   virtual DtReal contourFlightVelocityThreshold() const;
   virtual void setContourFlightVelocityThreshold(const DtReal value);

   virtual DtReal contourFlightPositionThreshold() const;
   virtual void setContourFlightPositionThreshold(const DtReal value);

   virtual DtReal heightFeedbackGain() const;
   virtual void setHeightFeedbackGain(const DtReal value);

   virtual const Dt1DRegularTableFn& heightVersusSpeed() const;
   virtual void setHeightVersusSpeed(const Dt1DRegularTableFn& value);

   virtual bool isAlignWithTargets() const;
   virtual void setIsAlignWithTargets(const bool val);

   virtual double maxSpeedForHeadingControl() const;
   virtual void setMaxSpeedForHeadingControl(const double speed);

   virtual DtReal positionGain() const;
   virtual void setPositionGain(const DtReal val);

   virtual DtReal velocityGain() const;
   virtual void setVelocityGain(const DtReal val);

   virtual DtReal yawPositionGain() const;
   virtual void setYawPositionGain(const DtReal val);

   virtual DtReal yawRateGain() const;
   virtual void setYawRateGain(const DtReal val);

   virtual DtReal landingFuelLevel() const;
   virtual void setLandingFuelLevel(const DtReal val);


   virtual double rotorSpinupTime() const;
   virtual void setRotorSpinupTime(double s); 

   static DtComponentDescriptor * creator();

protected:
   DtRotaryWingPilotDescriptor();

protected:

   DtRwReal             myContourFlightVelocityThreshold;

   DtRwReal             myContourFlightPositionThreshold;

   DtRwReal             myHeightFeedbackGain;

   Dt1DRegularTableFn   myHeightVersusSpeed;

   DtRwBoolean          myIsAlignWithTargets;

   DtRwReal myMaxSpeedForHeadingControl;

   DtRwReal             myPositionGain;

   DtRwReal             myVelocityGain;

   DtRwReal             myYawPositionGain;

   DtRwReal             myYawRateGain;

   DtRwReal             myLandingFuelLevel;

   DtRwReal myRotorSpinupTime;

   DtRwResource myFuelType;
};