airRefuelSupplierController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/controllerComponent.h"
#include "vrfmodel/airRefuelSupplierStateData.h"
#include "vrfmodel/vrfmodelDefines.h"
#include "vrfLua/luaScriptInterfaceImpl.h"
#include "vrfmodel/bindableLuaComponent.h"
#include "vrfmodel/resupplySupplierController.h"
#include "vrfobjparam/airRefuelSupplierControllerDescriptor.h"

#include "vrfobjcore/integerIOPort.h"
#include "matrix/vlVector.h"

class DtString;
class DtSimManager;
class DtIntegerOutputPort;   
class DtSimObjectBaseObjectStateRepository;
class DtAirRefuelSupplierControllerDescriptor;
class DtAirRefuelSupplierControllerPSR;
class DtInternalTransferFuelTask;

enum DtRefuelPointState
{
   State_Disabled = 0,  
   State_Enabled = 1,   
   State_Occupied = 2   
};

class DT_DLL_vrfmodel DtAirRefuelSupplierController : public DtResupplySupplierController,
   public DtBindableLuaComponent<DtAirRefuelSupplierController>
{

public:

   DtAirRefuelSupplierController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtAirRefuelSupplierController();

   virtual bool init();

   virtual const char* type() const;

   virtual void preFirstTickInit();

   virtual void tick();

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

   static void internalTransferFuelTaskCallback(DtSimMessage* msg, void* usr);

   static void setRefuelPointEnabledCallback(DtSimMessage * msg, void * usr);
   virtual void processSetRefuelPointEnabled(DtSimMessage* msg);

   virtual void setRefuelPointState(int point, DtRefuelPointState s);

   //returns the current state of the refuel point
   virtual const int refuelPointState(int point) const;

   //updates the refuel point state
   virtual void initRefuelPointList() const;

   //updates the refuel point state
   //virtual void updateRefuelPointList() const;

   //returns whether the refuel point is enabled or disabled
   virtual const bool isRefuelPointEnabled(int point) const;



   virtual const DtRefuelPoint* lookupRefuelPoint(int artPart) const;

   virtual void bindLuaFunctions(lua_State* L);
   virtual void bindLuaGlobals(lua_State* L);

public:
   virtual void enable(int artPart);
   virtual bool isEnabled(int artPart) const;

   virtual void disable(int artPart);
   virtual bool isDisabled(int artPart) const;

   virtual void setOccupied(int artPart);
   virtual bool isOccupied(int artPart) const;

   virtual const std::string lookUpSupplyType(const char* type) const;

   virtual const DtVectorOffset3D lookupPointOffset(int artPart) const;

   virtual const int lookupRefuelPointState(int artPart) const;

   virtual bool isDrogue(int artPart) const;

   virtual bool isBoom(int artPart) const;


protected:

   virtual DtAirRefuelSupplierControllerPSR* createAirRefuelPSR();

protected:
   virtual void processInternalTransferFuelTask(DtSimMessage* msg);
   virtual void processInternalTransferFuelTaskPSR();

   virtual void retrieveInternalTransferFuelTaskParams(const DtInternalTransferFuelTask* internalTransferFuelTask,
                                                       double & quantityRequestedTotal,
                                                       double & rate);

   virtual void retrieveInternalTransferFuelTaskParamsPSR(const DtInternalTransferFuelTask* internalTransferFuelTask,
                                                          double & supply,
                                                          double & rate);

   virtual bool verifyInternalTransferFuelTaskParams(double amount, double rate);

   virtual void internalTransferFuel();
   virtual void processReceivingState();

   virtual void updateTaskedSupplies(double quantityRequestedTotal,
                                     double rate);
   virtual void updateReceivedSupplies(DtTime interval);

   virtual bool checkResourceFillUp();
   virtual double resourceFillUp();
   virtual bool checkResourceAvailable();
   virtual double resourceAvailable();
   virtual void updateResources(double quantity);
   virtual void updatePSR();

   virtual double selfRefuelMaxRate();

private:
   DtAirRefuelSupplierController();
   DtAirRefuelSupplierController(const DtAirRefuelSupplierController & orig);
   const DtAirRefuelSupplierController & operator=(const 
      DtAirRefuelSupplierController & orig);

protected:

   //DtRwProperties myStateProperties;

   DtAirRefuelSupplierControllerDescriptor* myDescriptor;

   DtAirRefuelSupplierControllerPSR* myProcessState;

   DtAirRefuelSupplierStateData myAirRefuelSupplierStateData;

protected:
   const double theTotalReceivedAmountCompletePercentage = 0.999;
};