remoteEnvironmentController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfcontrol/vrfcontrolDefines.h"
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include <vrfExtObjects/vrfEnvironmentalWeatherStateRecord.h>
#include <vrfExtObjects/vrfSimulationDateTimeStateRecord.h>
#include <vrfExtObjects/controlObjectRepository.h>
#include <vlutil/vlString.h>
#include <vrfutil/rwUUID.h>
#include <matrix/vlVector.h>
#include <readerWriter/noArgumentCallbackList.h>

#include <map>
#include "vl/reflectedObjectListDIS.h"

class DtVrfMessageInterface;
class DtReflectedEnvironmentProcessList;
class DtReflectedEnvironmentProcess;
class DtEnvironmentProcessRepository;
class DtWeatherObjectRepository;
class DtVrfEnvironmentalWeatherStateRecord;
class DtVrfSimulationDateTimeStateRecord;
class DtReflectedObject;


typedef DtCallbackList<const DtEnvironmentProcessRepository*> DtGlobalWeatherCreatedCallbackList;

class DT_DLL_vrfcontrol DtRemoteEnvironmentController
{
public:
   DtRemoteEnvironmentController();

   virtual ~DtRemoteEnvironmentController();

   virtual void init(DtVrfMessageInterface* msgIf,
      DtReflectedEnvironmentProcessList* rel, int sessionId);

   virtual void reinitialize(DtReflectedEnvironmentProcessList* rel);

   static bool envProcessDiscoveryCriteria(
      DtReflectedObject* envProcess, void* userData);
   virtual bool processEnvProcessDiscoveryCriteria(
      DtReflectedEnvironmentProcess* envProcess);

   bool reflectingCurrentWeatherState();

   DtEnvironmentProcessRepository* globalEnvironment() const
   {
      return myGlobalWeatherSR;
   }


   virtual void setAirTurbidity(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double airTurbidity(const DtVector& geocentricLocation);


   virtual void setAmbientAirTemperature(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double ambientAirTemperature(const DtVector& geocentricLocation);


   virtual void setCloudState(DtVrfWeatherCloudState, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual DtVrfWeatherCloudState cloudState(const DtVector& geocentricLocation);


   virtual void setPrecipitationIntensity(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double precipitationIntensity(const DtVector& geocentricLocation);


   virtual void setPrecipitationType(DtVrfWeatherPrecipitationType, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual DtVrfWeatherPrecipitationType precipitationType(const DtVector& geocentricLocation);


   virtual void setWindSpeed(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double windSpeed(const DtVector& geocentricLocation);


   virtual void setWindDirection(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double windDirection(const DtVector& geocentricLocation);


   virtual void setVisibility(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double visibility(const DtVector& geocentricLocation);


   virtual void setTimeOfDay(double secondsPastMidnight);
   virtual double timeOfDay();


   virtual void setDateAndTimeOfDay(double secondsPastUtc);
   virtual void setDateAndTimeOfDay(int year, int month, int day, int hours, int minutes, int seconds);

   virtual double dateAndTimeOfDay();
   virtual void dateAndTimeOfDay(int& year, int& month, int& day, int& hours, int& minutes, int& seconds);

   virtual void setUseDayNightIlluminationModel(bool value);


   virtual void setTimeOfDayAdvancementSpeed(double speed);
   virtual double timeOfDayAdvancementSpeed();


   virtual void setUnderwaterVisibility(double underwaterVisibility, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double underwaterVisibility(const DtVector& geocentricLocation);


   virtual void setSurfaceTransparency(double transparency, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double surfaceTransparency(const DtVector& geocentricLocation);


   virtual void setWaterCurrentSpeed(double waterCurrentSpeed, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double waterCurrentSpeed(const DtVector& geocentricLocation);


   virtual void setWaterCurrentDirection(double waterCurrentDirection, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double waterCurrentDirection(const DtVector& geocentricLocation);


   virtual void setAmbientWaterTemperature(double waterTemperature, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double ambientWaterTemperature(const DtVector& geocentricLocation);


   virtual void setTidalOffset(double tidalOffset, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double tidalOffset(const DtVector& geocentricLocation);


   virtual void setTidalDirection(bool tidalDirection, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual bool tidalDirection(const DtVector& geocentricLocation);


   virtual void setSwellState(unsigned int state, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual unsigned int swellState(const DtVector& geocentricLocation);


   virtual void setSwellStateDirection(double direction, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double swellStateDirection(const DtVector& geocentricLocation);

   virtual void setSeaState(unsigned int douglasScale, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual unsigned int seaState(const DtVector& geocentricLocation);

   virtual void setSeaStateDirection(double radiansFromNorth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double seaStateDirection(const DtVector& geocentricLocation);

   virtual void setWindDrivenSeaStateEnabled(bool enabled, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual bool windDrivenSeaStateEnabled(const DtVector& geocentricLocation);


   virtual void setChoppiness(double choppiness, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double choppiness(const DtVector& geocentricLocation);


   virtual void setSurgeDepth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double surgeDepth(const DtVector& geocentricLocation);

   virtual void setFogColor(const DtVector&, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual DtVector fogColor(const DtVector& geocentricLocation);

   virtual void setFogHeight(double, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double fogHeight(const DtVector& geocentricLocation);

   virtual void setSnowAccumulation(double, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double snowAccumulation(const DtVector& geocentricLocation);

   virtual void setSnowMinimumAltitude(double, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double snowMinimumAltitude(const DtVector& geocentricLocation);

   virtual void setSnowRoadAccumulation(double, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double snowRoadAccumulation(const DtVector& geocentricLocation);

   virtual void setRainAccumulation(double, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double rainAccumulation(const DtVector& geocentricLocation);



   virtual void setThermoclineLayer1Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer1Depth(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer1Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer1Permeability(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer2Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer2Depth(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer2Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer2Permeability(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer3Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer3Depth(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer3Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer3Permeability(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer4Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer4Depth(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer4Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer4Permeability(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer5Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer5Depth(const DtVector& geocentricLocation);
   virtual void setThermoclineLayer5Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
   virtual double thermoclineLayer5Permeability(const DtVector& geocentricLocation);

   static void environmentProcessAddedCallback(
      DtReflectedEnvironmentProcess* obj, void* userData);
   virtual void processEnvironmentProcessAdded(
      DtReflectedEnvironmentProcess* obj);
   
   static void environmentProcessRemovedCallback(
      DtReflectedEnvironmentProcess* obj, void* userData);
   virtual void processEnvironmentProcessRemoved(
      DtReflectedEnvironmentProcess* obj);

   virtual double dT() const;


   virtual void addGlobalEnvironmentCreatedCallback(
      DtGlobalWeatherCreatedCallbackList::DtCallbackFunctionType fcn, void* usr) const;
   virtual void removeGlobalEnvironmentCreatedCallback(
      DtGlobalWeatherCreatedCallbackList::DtCallbackFunctionType fcn, void* usr) const;
   virtual void invokeGlobalWeatherCreatedCallbacks();

protected:

   virtual DtVrfEnvironmentalWeatherStateRecord* weatherObjectFor(const DtVector& geocentricLocation) const;

   virtual bool inside(const DtVector&, const DtControlObjectRepository::DtCOVertexList&) const;

protected:
   virtual bool updateGlobalEnvironment();
   
   virtual bool updateWeatherEnvironment(DtEnvironmentProcessRepository*, DtVrfEnvironmentalWeatherStateRecord*);

   static void environmentProcessUpdatedCallback(DtReflectedEnvironmentProcess* e, void* usr);
   virtual void processUpdatedCallback(DtReflectedEnvironmentProcess* e);

protected:
   DtReflectedEnvironmentProcessList* myReflectedEnvironmentProcessList;
   DtVrfMessageInterface* myMsgIf;

   typedef std::map<DtControlObjectRepository*, DtVrfEnvironmentalWeatherStateRecord*> WeatherObjects;
   WeatherObjects myWeatherObjects;

   DtEnvironmentProcessRepository* myGlobalWeatherSR;
   DtVrfEnvironmentalWeatherStateRecord* myGlobalWeatherStateRecord;
   DtVrfSimulationDateTimeStateRecord* mySimulationDateTimeStateRecord;

   double myLastTimeReceived;
   int mySessionId;

   mutable DtGlobalWeatherCreatedCallbackList myGlobalEnvironmentCreated;
};