weatherStateRepository.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/vrfOverlayObjectStateRepository.h"
#include <vrfutil/rwWindLevels.h>
#include <vrfExtObjects/vrfWeatherStateEnums.h>

class DT_DLL_vrfobjcore DtWeatherStateRepository : public DtVrfOverlayObjectStateRepository
{
public:
   DtWeatherStateRepository (DtVrfObject* vrfObject,
      const DtObjectType& objectType, DtVrfObjectParameters* parameters,
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0);

   DtWeatherStateRepository(const DtWeatherStateRepository& orig,
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0);

   DtWeatherStateRepository& operator=(const DtWeatherStateRepository& orig);

   virtual ~DtWeatherStateRepository();

   virtual void resetToDefaults();

   static DtVrfObjectStateRepository* creator(const DtString& name,
      DtVrfObject* vrfObject, const DtObjectType& objectType,
      DtVrfObjectParameters* parameters, DtReaderWriterRegistry* parentRegistry);

   static DtWeatherStateRepository* 
      isWeatherStateRepository(DtSimObjectStateRepository* repository);

   virtual DtSimObjectStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const;

   virtual DtString type() const;


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


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


   virtual void setAmbientAirPressure(double value);
   virtual double ambientAirPressure() const;


   virtual void setAirTemperatureAltitude(double value);
   virtual double airTemperatureAltitude() const;


   virtual void setAirPressureAltitude(double value);
   virtual double airPressureAltitude() const;


   virtual void setAirTemperatureAltitudeIsSeaLevel(bool value);
   virtual bool airTemperatureAltitudeIsSeaLevel() const;


   virtual void setAirPressureAltitudeIsSeaLevel(bool value);
   virtual bool airPressureAltitudeIsSeaLevel() const;


   virtual void setSeaLevelWaterConcentration(double value);
   virtual double seaLevelWaterConcentration() const;


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


   virtual void setPrecipitationType(DtVrfWeatherPrecipitationType value);
   virtual DtVrfWeatherPrecipitationType precipitationType() const;


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


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

   virtual void setAirTurbulence(int value);
   virtual int airTurbulence() const;
   




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

   virtual double visibility(const DtVector& location) const;


   virtual void setPriority(int value);
   virtual int priority() const;


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


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


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


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


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


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


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


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


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


   virtual void setSeaState(unsigned int state);
   virtual unsigned int seaState() const;


   virtual void setSeaStateDirection(double direction);
   virtual double seaStateDirection() const;


   virtual void setWindDrivenSeaStateEnabled(bool b);
   virtual bool windDrivenSeaStateEnabled() const;


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


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


   virtual void setFogHeight(double depth);
   virtual double fogHeight() const;


   virtual void setFogColor(const DtVector& color);
   virtual const DtVector& fogColor() const;


   virtual void setSnowAccumulation(double snow);
   virtual double snowAccumulation() const;


   virtual void setSnowMinimumAltitude(double snow);
   virtual double snowMinimumAltitude() const;


   virtual void setSnowRoadAccumulation(double snow);
   virtual double snowRoadAccumulation() const;


   virtual void setRainAccumulation(double rain);
   virtual double rainAccumulation() const;


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

   //{@
   virtual void setLightningPresent(bool isPresent);
   virtual bool lightningPresent() const;

   
   virtual void addWindLevel(const DtRwWindLevel&);
   virtual void addWindLevel(double altMSL, double windSpeed, double windDirection, double visibilityDistance, int visibilityObscurant);
   virtual void clearWindLevels();
   virtual bool windLevelsChanged() const;
   virtual void clearWindLevelsChanged();

   virtual void removeWindLevel(double baseAltitude);

   virtual bool windSpeedAndDirectionAtAltitude(double altMSL, double& windSpeed, double& windDirection) const;

   virtual bool visibilityAndObscurantAtAltitude(double altMSL, double& visibility, int& obscurrant) const;

   virtual void setWindLevels(const DtRwWindLevels&);
   virtual const DtRwWindLevels& windLevels() const;

   virtual void postGetSelf();

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);  

private:
   DtWeatherStateRepository();

protected:


   DtRwReal          myAirTurbidity;

   DtRwReal          myAmbientAirTemperature;   
   
   DtRwReal          myAmbientAirPressure;

   DtRwReal          myAirTemperatureAltitude;

   DtRwReal          myAirPressureAltitude;

   DtRwBoolean          myAirTemperatureAltitudeIsSeaLevel;

   DtRwBoolean          myAirPressureAltitudeIsSeaLevel;

   DtRwReal          mySeaLevelWaterConcentration;

   DtRwReal          myPrecipitationIntensity;

   DtRwInt           myPrecipitationType;

    DtRwInt          myAirTurbulence;

   DtRwInt            myPriority;

   DtRwReal myUnderwaterVisibility;

   DtRwReal mySurfaceTransparency;

   DtRwReal myWaterCurrentSpeed;

   DtRwReal myWaterCurrentDirection;

   DtRwReal myAmbientWaterTemperature;

   DtRwReal myTidalOffset;

   DtRwBoolean myTidalDirection;

   DtRwInt  mySwellState;

   DtRwReal mySwellStateDirection;

   DtRwInt  mySeaState;

   DtRwReal mySeaStateDirection;

   DtRwBoolean myWindDrivenSeaStateEnabled;

   DtRwReal myChoppiness;

   DtRwReal mySurgeDepth;

   DtRwReal myFogHeight;

   DtRwVector myFogColor;

   DtRwReal mySnowAccumulation;

   DtRwReal mySnowMinimumAltitude;

   DtRwReal mySnowRoadAccumulation;

   DtRwReal myRainAccumulation;

   DtRwReal myThermoclineLayer1Depth;

   DtRwReal myThermoclineLayer1Permeability;

   DtRwReal myThermoclineLayer2Depth;
   DtRwReal myThermoclineLayer2Permeability;

   DtRwReal myThermoclineLayer3Depth;
   DtRwReal myThermoclineLayer3Permeability;

   DtRwReal myThermoclineLayer4Depth;
   DtRwReal myThermoclineLayer4Permeability;

   DtRwReal myThermoclineLayer5Depth;
   DtRwReal myThermoclineLayer5Permeability;

   DtRwBoolean myLightningPresent;


   DtRwWindLevels myWindLevels;
   bool myWindLevelsChanged;
};