surfaceEntityActuator.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/actuatorComponent.h"
#include "vrfobjcore/platformLocalObjectFacade.h"

class DtString;
class DtSimulationServices;
class DtSurfaceEntityStateRepository;
class DtSurfaceEntityActuatorDescriptor;
class DtConstrainedAnalogInputPort;
class DtBooleanOutputPort;
class DtSurfaceMovementPSR;
class DtUpdateRepositoryOutputPortGroup;

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtSurfaceEntityActuator : public DtActuatorComponent
{

public:

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

   virtual ~DtSurfaceEntityActuator() override;

   virtual bool init() override;

   virtual const char* type() const override;

   virtual bool postAddComponentsInit() override;

   virtual void initProcessSR();

   virtual void tick() override;
 
   virtual double calculateRudderYawAcceleration();
   
   virtual double calculateResistanceYawAcceleration();
   
   virtual const DtVector calculateThrottleAcceleration();

   virtual const DtVector calculateDragAcceleration();

   virtual bool clampSmallVelocityToZero();

   virtual double stoppingSpeed();

   virtual void useFuel(double fuelUsed);

   virtual double fuelLeft() const;

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

protected:
   virtual double fuelUsed(double speed) const;
   
   virtual bool createPortGroups() override;

   virtual bool createPorts() override;

   virtual void integratePosition(double dT);

   virtual void integrateOrientation(double dT);

   void constrainYawAcceleration(double& yawAcceleration, double yawRate,
      double maxYawRate, double dT);

   virtual void updateRepository();

   DtSurfaceEntityStateRepository * surfaceEntityState (void) const;

   virtual bool createPSR();

protected:
   
   DtSurfaceEntityActuator();

   DtSurfaceEntityActuator
      (const DtSurfaceEntityActuator & orig);

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


protected:

   DtSurfaceEntityStateRepository * mySurfaceEntityState;
   DtSurfaceEntityActuatorDescriptor * mySurfaceEntityActuatorDescriptor;


   DtInputPortGroup* mySurfaceControlPortGroup;

   DtConstrainedAnalogInputPort* myThrottlePort;

   DtConstrainedAnalogInputPort* myRudderPort;

   DtBooleanOutputPort * mySmallVelocityClampedPort;


   DtDcm myBodyToLocalMatrix;
   DtDcm myLocalToBodyMatrix;

   DtVector myLocalPosition;
   DtVector myRelativeVelocity;
   DtVector myRelativeAcceleration;
   DtTaitBryan myOrientation;
   DtVector myBodyRotationRates;
   DtVector myBodyRotationalAcceleration;

   DtSurfaceMovementPSR* myProcessState;

   bool myOutOfFuelWarningPrinted;

   DtUpdateRepositoryOutputPortGroup* myUpdateRepositoryOutputPortGroup;

   DtPlatformLocalObjectFacade myPlatformLocalObjectFacade;
};