time_zone_info.hpp

Go to the documentation of this file.

#pragma once
#include "collections/generic/list.hpp"
#include "day_of_week.hpp"
#include "icomparable.hpp"
#include "iequatable.hpp"
#include "date_time.hpp"
#include "object.hpp"
#include "ticks.hpp"
#include "string.hpp"

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;
      auto operator =(const transition_time&) -> transition_time& = default;
      
      
      [[nodiscard]] auto day() const noexcept -> xtd::uint32;
      
      [[nodiscard]] auto day_of_week() const noexcept -> xtd::day_of_week;
      
      [[nodiscard]] auto is_fixed_rule() const noexcept -> bool;
      
      [[nodiscard]] auto month() const noexcept -> xtd::uint32;
      
      [[nodiscard]] auto time_of_day() const noexcept -> xtd::date_time;
      
      [[nodiscard]] auto week() const noexcept -> xtd::uint32;
      
      
      [[nodiscard]] static auto create_fixed_date_rule(xtd::date_time time_of_day, xtd::uint32 month, xtd::uint32 day) -> transition_time;
      
      [[nodiscard]] static auto create_floating_date_rule(xtd::date_time time_of_day, xtd::uint32 month, xtd::uint32 week, xtd::day_of_week day_of_week) -> transition_time;
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const transition_time& tt) const noexcept -> bool override;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;
      
    private:
      xtd::uint32 day_ = 0;
      xtd::day_of_week day_of_week_ = xtd::day_of_week::sunday;
      bool is_fixed_date_rule_ = true;
      xtd::uint32 month_ = 0;
      xtd::date_time time_of_day_;
      xtd::uint32 week_ = 0;
    };
    
    class adjustment_rule : public xtd::iequatable<adjustment_rule>, public xtd::object {
    public:
      adjustment_rule() = default;
      adjustment_rule(const adjustment_rule&) = default;
      adjustment_rule(adjustment_rule&&) = default;
      auto operator =(const adjustment_rule&) -> adjustment_rule& = default;
      
      
      [[nodiscard]] auto date_end() const noexcept -> const xtd::date_time&;
      
      [[nodiscard]] auto date_start() const noexcept -> const xtd::date_time&;
      
      [[nodiscard]] auto daylight_delta() const noexcept -> xtd::time_span;
      
      [[nodiscard]] auto daylight_transition_end() const noexcept -> transition_time;
      
      [[nodiscard]] auto daylight_transition_start() const noexcept -> transition_time;
      
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const adjustment_rule& ar) const noexcept -> bool override;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize 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 xtd::string& id, const xtd::ticks& base_utc_offset, const xtd::string& daylight_name, const xtd::string& display_name, const xtd::string& standard_name, bool supports_daylight_saving_time);
    time_zone_info(const time_zone_info&) = default;
    time_zone_info(time_zone_info&&) = default;
    auto operator =(const time_zone_info&) -> time_zone_info& = default;
    
    
    [[nodiscard]] auto base_utc_offset() const noexcept -> xtd::ticks;
    
    [[nodiscard]] auto daylight_name() const noexcept -> const xtd::string&;
    
    [[nodiscard]] auto display_name() const noexcept -> const xtd::string&;
    
    [[nodiscard]] auto id() const noexcept -> const xtd::string&;
    
    [[nodiscard]] auto standard_name() const noexcept -> const xtd::string&;
    
    [[nodiscard]] auto supports_daylight_saving_time() const noexcept -> bool;
    
    
    [[nodiscard]] static auto local() noexcept -> const time_zone_info&;
    
    [[nodiscard]] static auto utc() noexcept -> const time_zone_info&;
    
    
    [[nodiscard]] auto compare_to(const time_zone_info& tzi) const noexcept -> xtd::int32 override;
    
    [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
    [[nodiscard]] auto equals(const time_zone_info& tzi) const noexcept -> bool override;
    
    [[nodiscard]] auto get_adjustment_rules() const noexcept -> xtd::array<adjustment_rule>;
    
    [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;
    
    [[nodiscard]] auto is_daylight_saving_time(const xtd::date_time& date_time) const noexcept -> bool;
    
    [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
    
    
    [[nodiscard]] static auto convert_time_to_utc(const xtd::date_time& date_time) -> xtd::date_time;
    
    [[nodiscard]] static auto get_system_time_zones() noexcept -> const xtd::collections::generic::list<time_zone_info>&;
    
    [[nodiscard]] static auto convert_time(const xtd::date_time& date_time, const xtd::time_zone_info& destination_time_zone) -> xtd::date_time;
    [[nodiscard]] static auto convert_time(const xtd::date_time& date_time, const xtd::time_zone_info& source_time_zone, const xtd::time_zone_info& destination_time_zone) -> xtd::date_time;
    
    [[nodiscard]] static auto convert_time_by_system_time_zone_id(const xtd::date_time& date_time, const xtd::string& destination_time_zone_id) -> xtd::date_time;
    [[nodiscard]] static auto convert_time_by_system_time_zone_id(const xtd::date_time& date_time, const xtd::string& source_time_zone_id, const xtd::string& destination_time_zone_id) -> xtd::date_time;
    
    [[nodiscard]] static auto convert_from_utc(const xtd::date_time& date_time, const xtd::time_zone_info& destination_time_zone) -> xtd::date_time;
    
    [[nodiscard]] static auto convert_to_utc(const xtd::date_time& date_time, const xtd::time_zone_info& source_time_zone) -> xtd::date_time;
    [[nodiscard]] static auto convert_to_utc(const xtd::date_time& date_time) -> xtd::date_time;
    
    [[nodiscard]] static auto time_find_system_time_zone_by_id(const string& id) -> time_zone_info;
    
  private:
    string id_;
    ticks base_utc_offset_;
    string daylight_name_;
    string display_name_;
    string standard_name_;
    bool supports_daylight_saving_time_ = false;
    xtd::collections::generic::list<adjustment_rule> adjustment_rules_;
  };
}