suppressionActuator.h

Go to the documentation of this file.

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




#pragma once

#include "vrfobjcore/actuatorComponent.h"

#include "vrfobjcore/vrfMovingObjectStateRepository.h"

class DtDetonationContext;
class DtSuppressionActuatorDescriptor;
class DtSuppressionActuatorPSR;
class DtSimRadio;


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

public:

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

   virtual ~DtSuppressionActuator();

   virtual bool init();

   virtual bool createPSR();

   static bool processDetonationCallback(const DtDetonationContext& detonationContext, void* usr);

   virtual bool processDetonationInsult(const DtDetonationContext& detonationContext);

   virtual const char* type() const;

   virtual void tick();

   static void setDestroyedCallback(DtSimMessage* msg, void* usrData);

   static void setRestoredCallback(DtSimMessage* msg, void* usrData);

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

protected:
   virtual void setDestroyed();

   virtual void setRestored();

   virtual bool registerForDetonations();

   virtual bool unregisterForDetonations();

   virtual void setRadio(DtSimRadio* radio);

   virtual bool isRegisteredForDetonations() const;
   virtual void setIsRegisteredForDetonations(const bool r);

   virtual double computeRecoveryRate();

   virtual double suppressionFromInsult(const double insult);

   virtual double computeInsultToSuppressionFactor();

   virtual double decaySuppressionValue(const double oldValue,
      const double dT);

   virtual DtVrfMovingObjectStateRepository::suppressionLevels
      updateSuppressionLevel(const double oldValue, const double newValue);

   virtual int suppressionValueBin(const double suppressionValue);

   virtual double detonationInsult(const double maxEffect,
      const double maxRange, const double range);

   virtual double rangeToTrajectory(const DtDetonationContext& context,
      const double rangeToDetonation);

protected:
   DtSuppressionActuatorDescriptor* mySuppressionActuatorDescriptor;

   bool myIsRegisteredForDetonations;

   DtSuppressionActuatorPSR* myProcessState;

   double myInsultFactor;
   double myRecoveryRate;

private:
   DtSuppressionActuator();

   DtSuppressionActuator(const DtSuppressionActuator& orig);

   DtSuppressionActuator& operator=(const DtSuppressionActuator& orig);
};