timeZoneManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vlutil/vlFilename.h>
#include <matrix/vlVector.h>
#include <time.h>
#include <boost/signals2.hpp>

#include <QtCore/QString>

namespace makVrv
{
   class DtDe;
}

class DtGeodeticCoord;

const char DtTimeDateFormatsSetStandard[] = "Standard";
const char DtTimeDateFormatsSetMilitary[] = "Military";

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtTimeZoneManager : public makVrv::DtVirtualBaseClass
   {
   public:

      struct TimezoneData
      {
         std::string abbrev;
         std::string title;
         double offset;          
         std::string location;
      };

      typedef std::map<std::string, TimezoneData> Timezones;
      struct IlluminationIconData
      {
         IlluminationIconData() : lowVal(0), highVal(0) {};

         IlluminationIconData(double l, double h, const std::string& i)
         : lowVal(l), highVal(h), iconFile(i)
         {
         }

         IlluminationIconData(const IlluminationIconData& orig)
         : lowVal(orig.lowVal), highVal(orig.highVal), iconFile(orig.iconFile)
         {
         }

         double lowVal;
         double highVal;
         std::string iconFile;
      };

      typedef std::map<int, std::vector<IlluminationIconData> > IlluminationIcon;

      typedef std::vector<std::string> DateTimeFormats;

      struct FormatsSet
      {
         Timezones timezones;
         DateTimeFormats dateTimeFormats;
      };

      typedef std::map<std::string, FormatsSet> FormatsSetsMap;

   public:
      DtTimeZoneManager(makVrv::DtDe&);

      virtual ~DtTimeZoneManager() override;

      static DtTimeZoneManager& instance(makVrv::DtDe& de);

      static void registerInstance(makVrv::DtDe&, DtTimeZoneManager*);

      virtual const Timezones& timezones() const;

      virtual void setUseLocalTimezone(bool);
      virtual bool useLocalTimezone() const;

      virtual void setBlockLocalTimeZoneUsage(bool);
      virtual bool blockLocalTimeZoneUsage() const;

      virtual void setDateAndTimeOfDayFormat(const std::string&);
      virtual std::string dateAndTimeOfDayFormat() const;

      virtual const DateTimeFormats& dateTimeFormats() const;
      virtual DateTimeFormats& dateTimeFormats();

      virtual time_t offsetForTimezone(const std::string& key) const;

      virtual time_t modifyTimeBasedOnTimezoneSelection(time_t);

      virtual void setCurrentTimezone(const std::string&);

      virtual std::string currentTimezone() const;

      virtual void setCurrentFormatsSet(const std::string&);

      virtual std::string currentFormatsSet() const;

      virtual std::string currentTimezoneAbbreviation() const;

      virtual std::string timezoneTitle() const;

      virtual time_t offsetForTimezone() const;

      virtual time_t convertFromLocalTimeToUtcTime(time_t) const;

      virtual time_t currentUtcDateTime() const;

      virtual time_t currentLocalDateTime() const;

      virtual time_t convertFromUtcTimeToLocalTime(time_t) const;
      virtual void convertFromUtcTimeToLocalTime(int y, int m, int d, int h, int mm, int sec,
         int& year, int& month, int& day, int& hours, int& minutes, int& seconds) const;
      virtual time_t convertToUtcTime(int y, int m, int d, int h, int mm, int sec) const;

      virtual time_t convert(const std::string& source, time_t, const std::string& dest);

      virtual void load(const DtFilename&, bool merge = false);

      virtual std::string dateTimeFormatString(time_t);

      virtual double illuminationValue(const DtGeodeticCoord& position, time_t time,
         double nighttimeMaximum = 0.1, double illuminationMinimum = 0.001, bool useGMTPosition = false, int* sunstate = 0) const;

      virtual double maximumNighttimeValue() const;
      virtual void setMaximumNighttimeValue(double);

      virtual double minimumIlluminationValue();
      virtual void setMinimumIlluminationValue(double);

      virtual std::string illuminationIcon(double illumination, int sunState) const;

      virtual void addIlluminationIcon(int sunState, double lowIllumination, double highIllumination, const std::string&);

      const IlluminationIcon& illuminationIcons() const
      {
         return myIlluminationIcons;
      }

      IlluminationIcon& illuminationIcons()
      {
         return myIlluminationIcons;
      }

      virtual void resetSystemDateTime();

      virtual time_t utcTime(struct tm* tod) const;

      virtual time_t offsetTimeByObserverPosition(time_t curTime) const;

      virtual time_t unoffsetTimeByObserverPosition(time_t curTime) const;

      virtual time_t timeZoneOffsetForPosition(const DtVector&) const;

      virtual time_t timeZoneOffsetForCurrentObserver() const;

      virtual time_t utcOffsetHours() const;

      virtual QString utcLabel() const;

      virtual time_t currentSimulationUtcTime() const;

   protected:
      virtual void tick();

   public:
      boost::signals2::signal<void (std::string, std::string)> signal_timezoneChanged;

      boost::signals2::signal<void (std::string)> signal_dateAndTimeFormatChanged;

      boost::signals2::signal<void(std::string)> signal_formatsSetChanged;

      boost::signals2::signal<void (time_t old, time_t newTime)> signal_utcTimeChangedWithObserverPosition;

   protected:
      Timezones myTimezones;
      makVrv::DtDe& myDe;
      double myNighttimeMaximumValue;
      double myMinimumIlluminationValue;

      IlluminationIcon myIlluminationIcons;
      DateTimeFormats myDateTimeFormats;

      FormatsSetsMap myFormatsSetsMap;

      time_t myCurrentObserverUTCOffsetTime;
      boost::signals2::scoped_connection myObserverTrackConnection;
      bool myBlockLocalTimeZoneUsage;
   };
}