fixedWingActuatorComponent.h

Go to the documentation of this file.

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



#pragma once

#include "vrfmodel/vrfmodelDefines.h"
#include "vrfutil/rwAirSpeedType.h"
#include "vrfobjcore/actuatorComponent.h"
#include "vrfobjcore/platformLocalObjectFacade.h"
#include <matrix/LibMatrix.h>
#include <vlpi/disEnums.h>

class DtString;
class DtSimulationServices;
class DtFixedWingEntityStateRepository;
class DtFixedWingActuatorDescriptor;
class DtFixedWingFlightPSR;
class DtAircraftFuelConsumptionModel;
class DtAirspeedCalculator;
class DtGroundInteractionPt;

class DtInputPortGroup;
class DtConstrainedAnalogInputPort;
class DtConstrainedDualAxisAnalogInputPort;
class DtBooleanInputPort;
class DtUpdateRepositoryOutputPortGroup;

class DT_DLL_vrfmodel DtFixedWingActuatorComponent : public DtActuatorComponent
{
public:

   DtFixedWingActuatorComponent(const DtString& name,
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);


   virtual ~DtFixedWingActuatorComponent() override;

   virtual bool init() override;

   virtual const char* type() const override;

   virtual void tick() override;

   static DtSimComponent * creator(const DtString& name,
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

public:
   virtual void calculateBodyVelocity(const DtVector& oldRelativeVelocity,
      const DtDcm& newLocalOrientation, DtVector& newBodyVelocity);

   virtual void calculateAirborneAcceleration(const DtVector oldLocalPosition,
      double oldSpeed, const DtDcm& newLocalOrientation,
      const DtVector& newBodyVelocity, double throttle,
      DtVector& newRelativeAcceleration);

protected:

   virtual void doFlying();

   virtual void doTaxiing();

   virtual bool isTouchingDown(const DtVector& newLocalPosition,
      const DtVector& newRelativeVelocity);

   virtual bool isTakingOff(bool isOnGround, double speed);

   virtual bool updateGroundInteractionPoints(
      DtGroundInteractionPt *left,
      DtGroundInteractionPt *right,
      DtGroundInteractionPt *nose,
      DtGroundInteractionPt *center,
      const DtDcm& localOrientation,
      const DtVector& localPosition,
      double halfHeightOfTerrainIntersectChord);

   virtual double calculateYawRate(double pedal);

   virtual double calculatePitchRate(double stickYValue);

   virtual double calculateRollRate(double stickXValue);

   virtual void calculateBodyRotationRates(double pedal, double stickXValue,
      double stickYValue, DtVector& newBodyRotationRates);

   virtual void calculateOrientation(const DtDcm&
      oldLocalOrientation, const DtVector& newBodyRotationRates,
      DtDcm& newLocalOrientation);

   virtual void calculateBodyGravity(const DtVector oldLocalPosition,
      const DtDcm& newLocalOrientation, DtVector& newBodyGravityAcceleration);

   virtual void calculateThrustAcceleration(double throttle,
      DtVector& newBodyThrustAccleration);

   virtual void calculateDragAcceleration(double oldSpeed,
      const DtVector& newBodyVelocity, bool flapsDeployed,
      DtVector& newBodyDragAccleration);

   virtual void fallFromSky(const DtString& reason = DtString::nullString());

   virtual bool collidesWithGround(const DtVector& oldLocalPosition,
      const DtVector& newLocalPosition, DtVector& localCenterGoundPosition);

   void integrate(const DtVector& oldLocalPosition,
      const DtVector& oldRelativeVelocity,
      const DtVector& newRelativeAcceleration, DtVector& newLocalPosition,
      DtVector& newRelativeVelocity,
      double maxSpeed = 0);


   virtual void useFuel(double fuelUsed);
   virtual double fuelLeft() const;

   virtual double fullMass() const;

   virtual double currentMass() const;

   virtual double calculateHeading(double oldHeading,
      double steering, double dT, double speed, double turningRadius);
   virtual void  calculateScalarVelocityAndAcceleration(
      double oldPitch, double &scalarVelocity, double &scalarAcceleration);
   virtual double calculateMaxGroundSpeed();
   virtual double calculateMaxGroundAcceleration();
   virtual double calculateAcceleration(double pitch, double maxSpeed,
      double maxAccel, double newSpeed);
   virtual double calculateAccelerationFromThrottle();

   virtual double calculateAccelerationFromSlope(double slope);

   virtual double calculateAccelerationFromResistance(double maxSpeed,
      double maxAccel);
   virtual double calculateAccelerationFromBrake(double otherAccels);

   virtual DtVector calculateProjectedLocation(
      const DtVector& oldLocalPosition, const DtVector& newBodyAcceleration,
      const DtVector& oldBodyVelocity, double newHeading);

   virtual bool calculateOrientationAndPositionOnGround(
      const DtVector& newLocalProjectedLocation, double newHeading,
      DtDcm& newLocalOrientation, DtVector& newLocalPosition);

   virtual void updateRepository(const DtVector& newLocalPosition,
      const DtVector& newRelativeVelocity,
      const DtVector& newRelativeAcceleration,
      const DtDcm& newLocalOrientation, const DtVector& newBodyRotationRates,
      bool isOnGround, const DtAppearance& newAppearance);

   virtual void updateAirspeedToRepository(const DtVector& newLocalPosition, const double altitude);

   virtual void updateDisplay() const;

   virtual double maxThrustAcceleration() const;
   virtual double maxClimbRate() const;
   virtual double maxYawVelocity() const;
   virtual double maxPitchVelocity() const;
   virtual double maxRollVelocity() const;
   virtual double maxAltitude() const;

   virtual bool createPortGroups() override;

   virtual bool createPorts() override;

   virtual bool createPSR();

   virtual bool createFuelConsumptionModel();

   virtual void sendDetonation(const DtVector& geocentricPosition);

   virtual void updateOrderedSpeed();

protected:

   DtFixedWingActuatorComponent();

   DtFixedWingActuatorComponent(const DtFixedWingActuatorComponent & orig);

   const DtFixedWingActuatorComponent & operator=(const
      DtFixedWingActuatorComponent & orig);

protected:

   DtFixedWingEntityStateRepository * myFixedWingEntityState;
   DtFixedWingActuatorDescriptor * myFixedWingActuatorDescriptor;
   DtAircraftFuelConsumptionModel * myFuelConsumptionModel;


   DtInputPortGroup* myFixedWingControlPortGroup;

   DtConstrainedAnalogInputPort* myThrottlePort;

   DtConstrainedDualAxisAnalogInputPort*  myStickPort;

   DtConstrainedAnalogInputPort* myPedalPort;

   DtConstrainedAnalogInputPort* myBrakePort;

   DtBooleanInputPort*           myFlapsDeployedPort;


   DtFixedWingFlightPSR* myProcessState;

   bool           mySentFallingMessage;

   bool           myPutTaxiingPlaneOnGround;

   DtUpdateRepositoryOutputPortGroup* myUpdateRepositoryOutputPortGroup;

   bool myPreviouslyHadData;
   bool myKeepParentPosition;

   DtAirspeedCalculator* myAirSpeedCalculator;

   double myLastSpeed;

   DtPlatformLocalObjectFacade myPlatformLocalObjectFacade;

   CACHED_NEXT_FRAME_STATE_PROPERTY(OrderedTrueAirSpeed);
   CACHED_NEXT_FRAME_STATE_PROPERTY(OrderedIndicatedAirSpeed);
   CACHED_NEXT_FRAME_STATE_PROPERTY(OrderedMachNumber);
   CACHED_NEXT_FRAME_STATE_PROPERTY(OrderedSpeedState);
   CACHED_NEXT_FRAME_STATE_PROPERTY(IndicatedAirspeed);
   CACHED_NEXT_FRAME_STATE_PROPERTY(TrueAirspeed);
   CACHED_NEXT_FRAME_STATE_PROPERTY(MachNumber);
};