DtEnvironmentRecord.h

Go to the documentation of this file.

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


#pragma once

#include <makArchives/makArchives.h>
#include <makArchives/DtCloudLayerRecord.h>
#include <vector>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtEnvironmentRecord
   {
   public:

      typedef std::vector<DtCloudLayerRecord> CloudLayerRecordList;

      DtEnvironmentRecord();

      DtEnvironmentRecord(const DtEnvironmentRecord& orig);

      DtEnvironmentRecord& operator=(DtEnvironmentRecord orig);

      ~DtEnvironmentRecord();

      void swap(DtEnvironmentRecord& other);

      void setAirTurbidity(float turbidity);
      float airTurbidity() const;
      
      void setVisibleDistance(float distance);
      float visibleDistance() const;
      
      void setPrecipitationEnabled(bool enabled);
      bool precipitationEnabled() const;
      
      void setPrecipitationType(const std::string&  type);
      const std::string& precipitationType() const;
      
      void setPrecipitationIntensity(float intensity);
      float precipitationIntensity() const;
      
      CloudLayerRecordList& cloudLayers();
      const CloudLayerRecordList& cloudLayers() const;         

      void setWindSpeed(float metersPerSecond);
      float windSpeed() const;

      void setWindDirection(float radiansFromNorth);
      float windDirection() const;

      void setAmbientAirTemperature(float celsius);
      float ambientAirTemperature() const;

      void setSeaState(int beaufortScale);
      int seaState() const;

      void setSeaChoppiness(float chop);
      float seaChoppiness() const;

      void setUnderwaterVisibility(float distanceInMeters);
      float underwaterVisibility() const;

      void setAmbientWaterTemperature(float celsius);
      float ambientWaterTemperature() const;

      void setWaterCurrentSpeed(float metersPerSecond);
      float waterCurrentSpeed() const;

      void setWaterCurrentDirection(float radiansFromNorth);
      float waterCurrentDirection() const;

      void setTidalOffset(float meters);
      float tidalOffset() const;

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

   protected:

      friend class boost::serialization::access;

      template<class Archive>
      void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myAirTurbidity);
         ar & BOOST_SERIALIZATION_NVP(myVisibilityDistance);
         ar & BOOST_SERIALIZATION_NVP(myPrecipitationEnabledFlag);
         ar & BOOST_SERIALIZATION_NVP(myPrecipitationType);
         ar & BOOST_SERIALIZATION_NVP(myPrecipitationIntensity);
         ar & BOOST_SERIALIZATION_NVP(myCloudLayers);

         if(version >= 1)
         {
            ar & BOOST_SERIALIZATION_NVP(myWindSpeed);
            ar & BOOST_SERIALIZATION_NVP(myWindDirection);
            ar & BOOST_SERIALIZATION_NVP(myAmbientAirTemperature);
            ar & BOOST_SERIALIZATION_NVP(mySeaState);
            ar & BOOST_SERIALIZATION_NVP(mySeaChoppiness);
            ar & BOOST_SERIALIZATION_NVP(myUnderwaterVisibility);
            ar & BOOST_SERIALIZATION_NVP(myAmbientWaterTemperature);
            ar & BOOST_SERIALIZATION_NVP(myWaterCurrentSpeed);
            ar & BOOST_SERIALIZATION_NVP(myWaterCurrentDirection);
            ar & BOOST_SERIALIZATION_NVP(myTidalOffset);
            ar & BOOST_SERIALIZATION_NVP(myTidalDirection);
         }
      }

      float myAirTurbidity;
      float myVisibilityDistance;
      bool myPrecipitationEnabledFlag;
      std::string myPrecipitationType;
      float myPrecipitationIntensity;
      CloudLayerRecordList myCloudLayers;
      float myWindSpeed;
      float myWindDirection;
      float myAmbientAirTemperature;

      int mySeaState;
      float mySeaChoppiness;
      float myUnderwaterVisibility;
      float myAmbientWaterTemperature;
      float myWaterCurrentSpeed;
      float myWaterCurrentDirection;
      float myTidalOffset;
      bool myTidalDirection;
   };
}

BOOST_CLASS_VERSION(makArchives::DtEnvironmentRecord,1)