time_zone_info.h

Go to the documentation of this file.

#pragma once
#include "argument_out_of_range_exception.h"
#include "day_of_week.h"
#include "icomparable.h"
#include "iequatable.h"
#include "date_time.h"
#include "object.h"
#include "ticks.h"
#include "ustring.h"

namespace xtd {
  class core_export_ time_zone_info : public xtd::icomparable<time_zone_info>, public xtd::iequatable<time_zone_info>, public xtd::object {
  public:
    
    class transition_time : public xtd::iequatable<transition_time>, public xtd::object {
    public:
      transition_time() = default;
      transition_time(const transition_time&) = default;
      transition_time(transition_time&&) = default;
      transition_time& operator =(const transition_time&) = default;
      
      
      uint32 day() const noexcept;
      
      xtd::day_of_week day_of_week() const noexcept;
      
      bool is_fixed_rule() const noexcept;
      
      uint32 month() const noexcept;
      
      xtd::date_time time_of_day() const noexcept;
      
      uint32 week() const noexcept;
      
      
      static transition_time create_fixed_date_rule(date_time time_of_day, uint32 month, uint32 day);
      
      static transition_time create_floating_date_rule(date_time time_of_day, uint32 month, uint32 week, xtd::day_of_week day_of_week);
      
      bool equals(const transition_time& tt) const noexcept override;
      
    private:
      uint32 day_ = 0;
      xtd::day_of_week day_of_week_ = xtd::day_of_week::sunday;
      bool is_fixed_date_rule_ = true;
      uint32 month_ = 0;
      xtd::date_time time_of_day_;
      uint32 week_ = 0;
    };
    
    class adjustement_rule : public xtd::iequatable<adjustement_rule>, public xtd::object {
    public:
      adjustement_rule() = default;
      adjustement_rule(const adjustement_rule&) = default;
      adjustement_rule(adjustement_rule&&) = default;
      adjustement_rule& operator =(const adjustement_rule&) = default;
      
      
      const xtd::date_time& date_end() const noexcept;
      
      const xtd::date_time& date_start() const noexcept;
      
      xtd::time_span daylight_delta() const noexcept;
      
      transition_time daylight_transition_end() const noexcept;
      
      transition_time daylight_transition_start() const noexcept;
      
      
      bool equals(const adjustement_rule& ar) const noexcept override;
      
    private:
      xtd::date_time date_end_ {date_time::max_value};
      xtd::date_time date_start_ {date_time::min_value};
      xtd::ticks daylight_delta_ {0};
      transition_time daylight_transition_end_;
      transition_time daylight_transition_start_;
    };
    
    time_zone_info() = default;
    time_zone_info(const ustring& id, const ticks& base_utc_offset, const ustring& daylight_name, const ustring& display_name, const ustring& standard_name, bool supports_daylight_saving_time);
    time_zone_info(const time_zone_info&) = default;
    time_zone_info(time_zone_info&&) = default;
    time_zone_info& operator =(const time_zone_info&) = default;
    
    
    ticks base_utc_offset() const noexcept;
    
    const ustring& daylight_name() const noexcept;
    
    const ustring& display_name() const noexcept;
    
    const ustring& id() const noexcept;
    
    static const time_zone_info& local() noexcept;
    
    const ustring& standard_name() const noexcept;
    
    bool supports_daylight_saving_time() const noexcept;
    
    static const time_zone_info& utc() noexcept;
    
    
    static xtd::date_time convert_time_to_utc(const xtd::date_time& date_time);
    
    static const std::list<time_zone_info>& get_system_time_zones() noexcept;
    
    int32 compare_to(const time_zone_info& tzi) const noexcept override;
    
    static xtd::date_time convert_time(const xtd::date_time& date_time, const xtd::time_zone_info& destination_time_zone);
    static xtd::date_time convert_time(const xtd::date_time& date_time, const xtd::time_zone_info& source_time_zone, const xtd::time_zone_info& destination_time_zone);
    
    static xtd::date_time convert_time_by_system_time_zone_id(const xtd::date_time& date_time, const xtd::ustring& destination_time_zone_id);
    static xtd::date_time convert_time_by_system_time_zone_id(const xtd::date_time& date_time, const xtd::ustring& source_time_zone_id, const xtd::ustring& destination_time_zone_id);
    
    static xtd::date_time convert_from_utc(const xtd::date_time& date_time, const xtd::time_zone_info& destination_time_zone);
    
    static xtd::date_time convert_to_utc(const xtd::date_time& date_time, const xtd::time_zone_info& source_time_zone);
    static xtd::date_time convert_to_utc(const xtd::date_time& date_time);
    
    bool equals(const time_zone_info& tzi) const noexcept override;
    
    std::vector<adjustement_rule> get_adjustement_rules() const noexcept;
    
    bool is_daylight_saving_time(const xtd::date_time& date_time) const noexcept;
    
    static time_zone_info time_find_system_time_zone_by_id(const ustring& id);
    
    xtd::ustring to_string() const noexcept override;
    
  private:
    ustring id_;
    ticks base_utc_offset_;
    ustring daylight_name_;
    ustring display_name_;
    ustring standard_name_;
    bool supports_daylight_saving_time_ = false;
    std::vector<adjustement_rule> adjustement_rules_;
  };
}