subSurfaceDepthController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/singleTaskControllerComponent.h"

class DtVrfMovingObjectStateRepository;
class DtSubSurfaceEntityParameters;
class DtAnalogOutputPort;
class DtSurfaceMovementPSR;

enum 
{
   DEPTH_TYPE_SURFACE = 0,
   DEPTH_TYPE_PERISCOPE = 1,
   DEPTH_TYPE_MAX = 2,
   DEPTH_TYPE_BOTTOM = 3,
   DEPTH_TYPE_SPECIFIED = 4
};

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtSubSurfaceDepthController : 
   public DtSingleTaskControllerComponent
{

public:

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

   virtual ~DtSubSurfaceDepthController();

   virtual const char* type() const;

   virtual bool init();
   
   static void gotoDepthCallback(DtSimMessage* msg, void* usr);
   
   virtual void processGotoDepthTask(DtSimMessage* msg);
   
   virtual void registerTaskMsgCallbacks();

   virtual void tick();

   virtual double entityDepth();


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


protected:
   
   virtual bool createPorts();
  
   virtual void clearTask();

   virtual void lookupAndCacheProcessSR();
 
   virtual bool postAddComponentsInit();

private:

   DtSubSurfaceDepthController();

   DtSubSurfaceDepthController(
      const DtSubSurfaceDepthController & orig);

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


protected:

   DtVrfMovingObjectStateRepository * myEntityState;


   DtSurfaceMovementPSR *myProcessState;

   const DtSubSurfaceEntityParameters* myParameters;



   DtAnalogOutputPort *myDepthRatePort;

   DtAnalogOutputPort *myClampDepthPort;

   double mySeaFloorAltitude;
   double mySeaSurfaceAltitude;
};