globalEnvironmentLocalNetInterface.h

Go to the documentation of this file.

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



#pragma once
#include "vrfobjcore/weatherLocalNetInterface.h"
#include <vrfExtObjects/vrfEnvironmentalWeatherStateRecord.h>

class DtVrfSimulationDateTimeStateRecord;
class DtGlobalEnvironmentStateRepository;

class DT_DLL_vrfobjcore DtVrfEnvironmentalWeatherStateRecord_V3 :
   public DtVrfEnvironmentalWeatherStateRecord
{
public:
   DtVrfEnvironmentalWeatherStateRecord_V3();

   DtVrfEnvironmentalWeatherStateRecord_V3(const DtVrfEnvironmentalWeatherStateRecord_V3& orig);

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

   virtual ~DtVrfEnvironmentalWeatherStateRecord_V3();

   virtual DtEnvironmentalRecord* clone() const;


   virtual void setAirTurbidity(double value);
   virtual double airTurbidity() const;


   virtual void setAmbientAirTemperature(double value);
   virtual double ambientAirTemperature() const;


    virtual void setCloudState(unsigned int value);
    virtual unsigned int cloudState() const;


   virtual void setPrecipitationIntensity(double value);
   virtual double precipitationIntensity() const;


   virtual void setPrecipitationType(unsigned int value);
   virtual unsigned int precipitationType() const;


   virtual void setWindSpeed(double value);
   virtual double windSpeed() const;


   virtual void setWindDirection(double value);
   virtual double windDirection() const;


   virtual void setVisibility(double value);
   virtual double visibility() const;


   virtual void setTimeOfDay(double seconds);
   virtual double timeOfDay() const;


   virtual void setTimeOfDayAdvancementSpeed(double factor);
   virtual double timeOfDayAdvancementSpeed() const;


   virtual void setUnderwaterVisibility(double underwaterVisibility);
   virtual double underwaterVisibility();


   virtual void setSurfaceTransparency(double transparency);
   virtual double surfaceTransparency();


   virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
   virtual double waterCurrentSpeed();


   virtual void setWaterCurrentDirection(double waterCurrentDirection);
   virtual double waterCurrentDirection();


   virtual void setAmbientWaterTemperature(double waterTemperature);
   virtual double ambientWaterTemperature();


   virtual void setTidalOffset(double tidalOffset);
   virtual double tidalOffset();


   virtual void setTidalDirection(bool tidalDirection);
   virtual bool tidalDirection();


   virtual void setSwellState(unsigned int state);
   virtual unsigned int swellState();


   virtual void setSwellStateDirection(double direction);
   virtual double swellStateDirection();

   virtual void setSeaState(unsigned int douglasScale);
   virtual unsigned int seaState();

   virtual void setSeaStateDirection(double radiansFromNorth);
   virtual double seaStateDirection();

   void setWindDrivenSeaStateEnabled(bool enabled);
   bool windDrivenSeaStateEnabled();


   virtual void setChoppiness(double choppiness);
   virtual double choppiness();


   virtual void setSurgeDepth(double depth);
   virtual double surgeDepth();


   virtual void setThermoclineLayer1Depth(double depth);
   virtual double thermoclineLayer1Depth();
   virtual void setThermoclineLayer1Permeability(double depth);
   virtual double thermoclineLayer1Permeability();
   virtual void setThermoclineLayer2Depth(double depth);
   virtual double thermoclineLayer2Depth();
   virtual void setThermoclineLayer2Permeability(double depth);
   virtual double thermoclineLayer2Permeability();
   virtual void setThermoclineLayer3Depth(double depth);
   virtual double thermoclineLayer3Depth();
   virtual void setThermoclineLayer3Permeability(double depth);
   virtual double thermoclineLayer3Permeability();
   virtual void setThermoclineLayer4Depth(double depth);
   virtual double thermoclineLayer4Depth();
   virtual void setThermoclineLayer4Permeability(double depth);
   virtual double thermoclineLayer4Permeability();
   virtual void setThermoclineLayer5Depth(double depth);
   virtual double thermoclineLayer5Depth();
   virtual void setThermoclineLayer5Permeability(double depth);
   virtual double thermoclineLayer5Permeability();

   virtual bool createNetworkRepresentation();

   const DtNetWeatherStateRecord_V3* objStateNetRepV3() const;
   DtNetWeatherStateRecord_V3* objStateNetRepV3();

   virtual int netRepSize() const;

   DtVrfEnvironmentalWeatherStateRecord_V3* self() const;
};

class DT_DLL_vrfobjcore DtGlobalEnvironmentLocalNetInterface : public DtWeatherLocalNetInterface
{
protected:
   DtGlobalEnvironmentLocalNetInterface();


   virtual void setupMetocPublisher() override;
   virtual bool metocAvailable(DtString& reasonUnavailable) const;

public:

   DtGlobalEnvironmentLocalNetInterface(const DtString& name, 
      DtVrfObject* vrfObject,  
      DtReaderWriterRegistry* parentRegistry = 0,
      bool publishObject = true);

   DtGlobalEnvironmentLocalNetInterface(
      const DtGlobalEnvironmentLocalNetInterface & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

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

   virtual ~DtGlobalEnvironmentLocalNetInterface();

   virtual void updatePublisher();

   virtual void setupRecords();

   virtual DtString type() const;

   static DtSimObjectNetInterface* creator(const DtString& name, 
      DtVrfObject* vrfObject,  
      DtReaderWriterRegistry* parentRegistry,
      bool publishObject);

   virtual int weatherRecordIndex() const;

protected:
   virtual DtEnvironmentProcessPublisher* _createPublisher(const DtEntityIdentifier& id = DtEntityIdentifier::nullId()) const;
   virtual void updateStateRecord(DtWeatherStateRepository* localState);
   virtual void updateV3EnvironmentalRecord(DtWeatherStateRepository* localState);

protected:
   DtVrfSimulationDateTimeStateRecord* mySimulationDateTimeRecord;
   DtVrfEnvironmentalWeatherStateRecord_V3* myV3EnvironmentalRecord;
};