fixedWingEntityStateRepository.h

Go to the documentation of this file.

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

#pragma once



#include <vlutil/vlMachineTypes.h>
#include <matrix/vlVector.h>
#include "vrfobjcore/groundInteractionPt.h"
#include "vrfobjcore/vrfMovingObjectStateRepository.h"
#include <readerWriter/rwReal.h>
#include "vrfutil/rwAirSpeedType.h"

class DtFixedWingEntityParameters;

enum DtFixedWingCurrentState
{
   DtFWOnGround = 0,
   DtFWInAir = 1
};

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtFixedWingEntityStateRepository : public DtVrfMovingObjectStateRepository
{

protected:
   DtFixedWingEntityStateRepository();

public:

   DtFixedWingEntityStateRepository (DtVrfObject* vrfObject,
                                     const DtObjectType& objectType,
                                     DtVrfObjectParameters* parameters,
                                     const DtString& name,
                                     DtReaderWriterRegistry* parentRegistry = 0);

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

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

   virtual ~DtFixedWingEntityStateRepository();

   virtual bool init();

   virtual DtString type() const;

   virtual const int vrfMovingObjectStateRepositorySubType() const;

   virtual const int fixedWingEntityStateRepositorySubType() const;

   virtual bool createParameters();
   virtual void initializeFromParameters();
   virtual const DtFixedWingEntityParameters* fixedWingEntityParameters() const;

   virtual DtReal AOA() const;
   virtual void setAOA (DtReal aoa);

   virtual DtReal minLiftSpeed() const;
   virtual void setMinLiftSpeed (DtReal minLiftSpeed);

   virtual DtReal maxAltitude() const;
   virtual void setMaxAltitude (DtReal maxAltitude);

   virtual DtReal maxYawRate() const;
   virtual void setMaxYawRate (DtReal maxYawRate);

   virtual DtReal maxPitchRate() const;
   virtual void setMaxPitchRate (DtReal maxPitchRate);

   virtual DtReal maxRollRate() const;
   virtual void setMaxRollRate (DtReal maxRollRate);

   virtual DtReal maxClimbRate() const;
   virtual void setMaxClimbRate (DtReal maxClimbRate);

   virtual DtReal orderedGroundSpeed() const;
   virtual void setOrderedGroundSpeed (DtReal orderedGroundSpeed);

   virtual DtReal maxGroundSpeed() const;
   virtual void setMaxGroundSpeed (DtReal maxGroundSpeed);

   virtual DtReal maxGroundStoppingDeceleration() const;
   virtual void setMaxGroundStoppingDeceleration (DtReal maxGroundStoppingDeceleration);

   virtual DtReal groundTurningRadius() const;
   virtual void setGroundTurningRadius (DtReal groundTurningRadius);

   virtual DtReal maxGroundSlope() const;
   virtual void setMaxGroundSlope (DtReal maxGroundSlope);

   virtual bool onGround() const;

   virtual boost::tribool onTerrainSurface() const;

   virtual void setOnGround(bool onGround);

   virtual void setCurrentOrderedSpeed(const double currentOrderedSpeed);
   virtual const double currentOrderedSpeed() const;

   virtual void setCurrentMaxSpeed(const double currentMaxSpeed);
   virtual const double currentMaxSpeed() const;

   virtual void setCurrentMaxStoppingDeceleration(const double currentMaxStoppingDeceleration);
   virtual const double currentMaxStoppingDeceleration() const;

   virtual void setCurrentTurningRadius(const double currentTurningRadius);
   virtual const double currentTurningRadius() const;

   virtual void attachToParent(const DtUUID& parent);

   virtual void setCurrentMaxSlope(const double currentMaxSlope);
   virtual const double currentMaxSlope() const;

   virtual void setOnGroundTolerance(double);
   virtual double onGroundTolerance() const;

   virtual DtReal orderedAirSpeed() const;
   virtual void setOrderedAirSpeed(DtReal orderedAirSpeed);

   virtual void setOrderedAirSpeedType(const DtAirSpeedType &airSpeedType);
   virtual DtAirSpeedType orderedAirSpeedType() const;

   virtual void place (const DtVector& location, const DtReal heading, 
      bool clampToGroundFlag = true, bool* dataAvailable = 0, 
      bool requireAllData = false);

   virtual void placeAtAltitude (const DtVector& location, const DtReal heading);

   virtual void updateCurrentStateVars();

   virtual const DtGroundInteractionPt* noseSupport() const;
   virtual DtGroundInteractionPt* noseSupport();
   virtual void setNoseSupport(const DtVector& noseSupport);

   static DtVrfObjectStateRepository* creator (const DtString& name,
      DtVrfObject* vrfObject, const DtObjectType& objectType,
      DtVrfObjectParameters* parameters, 
      DtReaderWriterRegistry* parentRegistry);

   static DtFixedWingEntityStateRepository* isFixedWingEntityStateRepository(
      DtSimObjectStateRepository* repository);

   static const DtFixedWingEntityStateRepository* isFixedWingEntityStateRepository(
      const DtSimObjectStateRepository* repository);

   virtual void restoreEntity();

   virtual void updateAppearanceFromState();

protected:
   DtRwReal     myAOA;
   DtRwReal     myMinLiftSpeed;
   DtRwReal     myMaxAltitude;
   DtRwReal     myMaxClimbRate;
   DtRwReal     myMaxYawRate;
   DtRwReal     myMaxPitchRate;
   DtRwReal     myMaxRollRate;
   
   DtRwReal     myOrderedGroundSpeed;
   DtRwReal     myMaxGroundSpeed;
   DtRwReal     myMaxGroundStoppingDeceleration;
   DtRwReal     myGroundTurningRadius;
   DtRwReal     myMaxGroundSlope;

   DtRwBoolean  myOnGround;
   DtRwReal     myCurrentOrderedSpeed;
   DtRwReal     myCurrentMaxSpeed;
   DtRwReal     myCurrentMaxStoppingDeceleration;
   DtRwReal     myCurrentTurningRadius;
   DtRwReal     myCurrentMaxSlope;

   DtRwReal     myOnGroundTolerance;

   DtRwReal     myOrderedAirSpeed;
   DtRwAirSpeedType     myOrderedAirSpeedType;
};