sl@0: #ifndef DATE_TIME_TIME_HPP___
sl@0: #define DATE_TIME_TIME_HPP___
sl@0: 
sl@0: /* Copyright (c) 2002,2003,2005 CrystalClear Software, Inc.
sl@0:  * Use, modification and distribution is subject to the 
sl@0:  * Boost Software License, Version 1.0. (See accompanying
sl@0:  * file LICENSE-1.0 or http://www.boost.org/LICENSE-1.0)
sl@0:  * Author: Jeff Garland, Bart Garst
sl@0:  * $Date: 2005/04/23 05:39:52 $
sl@0:  */
sl@0: 
sl@0: 
sl@0: /*! @file time.hpp
sl@0:   This file contains the interface for the time associated classes.
sl@0: */
sl@0: #include "boost/date_time/time_defs.hpp"
sl@0: #include "boost/operators.hpp"
sl@0: #include <string>
sl@0: 
sl@0: namespace boost {
sl@0: namespace date_time {
sl@0: 
sl@0:   //! Representation of a precise moment in time, including the date.
sl@0:   /*! 
sl@0:     This class is a skeleton for the interface of a temporal type
sl@0:     with a resolution that is higher than a day.  It is intended that 
sl@0:     this class be the base class and that the actual time 
sl@0:     class be derived using the BN pattern.  In this way, the derived 
sl@0:     class can make decisions such as 'should there be a default constructor' 
sl@0:     and what should it set its value to, should there be optional constructors
sl@0:     say allowing only an time_durations that generate a time from a clock,etc.
sl@0:     So, in fact multiple time types can be created for a time_system with
sl@0:     different construction policies, and all of them can perform basic
sl@0:     operations by only writing a copy constructor.  Finally, compiler 
sl@0:     errors are also shorter. 
sl@0:     
sl@0:     The real behavior of the time class is provided by the time_system
sl@0:     template parameter.  This class must provide all the logic
sl@0:     for addition, subtraction, as well as define all the interface
sl@0:     types.
sl@0:     
sl@0:   */
sl@0: 
sl@0:   template <class T, class time_system>
sl@0:   class base_time : private
sl@0:       boost::less_than_comparable<T
sl@0:     , boost::equality_comparable<T
sl@0:       > >
sl@0:   {
sl@0:   public:
sl@0:     typedef T time_type;
sl@0:     typedef typename time_system::time_rep_type time_rep_type;
sl@0:     typedef typename time_system::date_type date_type;
sl@0:     typedef typename time_system::date_duration_type date_duration_type;
sl@0:     typedef typename time_system::time_duration_type time_duration_type;
sl@0:     //typedef typename time_system::hms_type hms_type;
sl@0:     
sl@0:     base_time(const date_type& day, 
sl@0:               const time_duration_type& td, 
sl@0:               dst_flags dst=not_dst) :
sl@0:       time_(time_system::get_time_rep(day, td, dst))
sl@0:     {}
sl@0:     base_time(special_values sv) :
sl@0:       time_(time_system::get_time_rep(sv))
sl@0:     {}
sl@0:     base_time(const time_rep_type& rhs) :
sl@0:       time_(rhs)
sl@0:     {}
sl@0:     date_type date() const
sl@0:     {
sl@0:       return time_system::get_date(time_);
sl@0:     }
sl@0:     time_duration_type time_of_day() const
sl@0:     {
sl@0:       return time_system::get_time_of_day(time_);
sl@0:     }
sl@0:     /*! Optional bool parameter will return time zone as an offset 
sl@0:      * (ie "+07:00"). Empty string is returned for classes that do 
sl@0:      * not use a time_zone */
sl@0:     std::string zone_name(bool as_offset=false) const
sl@0:     {
sl@0:       return time_system::zone_name(time_);
sl@0:     }
sl@0:     /*! Optional bool parameter will return time zone as an offset 
sl@0:      * (ie "+07:00"). Empty string is returned for classes that do 
sl@0:      * not use a time_zone */
sl@0:     std::string zone_abbrev(bool as_offset=false) const
sl@0:     {
sl@0:       return time_system::zone_name(time_);
sl@0:     }
sl@0:     //! An empty string is returned for classes that do not use a time_zone
sl@0:     std::string zone_as_posix_string() const
sl@0:     {
sl@0:       return std::string("");
sl@0:     }
sl@0: 
sl@0:     //! check to see if date is not a value
sl@0:     bool is_not_a_date_time()  const
sl@0:     {
sl@0:       return time_.is_not_a_date_time();
sl@0:     }
sl@0:     //! check to see if date is one of the infinity values
sl@0:     bool is_infinity()  const
sl@0:     {
sl@0:       return (is_pos_infinity() || is_neg_infinity()); 
sl@0:     }
sl@0:     //! check to see if date is greater than all possible dates
sl@0:     bool is_pos_infinity()  const
sl@0:     {
sl@0:       return time_.is_pos_infinity();
sl@0:     }
sl@0:     //! check to see if date is greater than all possible dates
sl@0:     bool is_neg_infinity()  const
sl@0:     {
sl@0:       return time_.is_neg_infinity();
sl@0:     }
sl@0:     //! check to see if time is a special value
sl@0:     bool is_special() const
sl@0:     {
sl@0:       return(is_not_a_date_time() || is_infinity());
sl@0:     }
sl@0:     //!Equality operator -- others generated by boost::equality_comparable
sl@0:     bool operator==(const time_type& rhs) const
sl@0:     {
sl@0:       return time_system::is_equal(time_,rhs.time_);
sl@0:     }
sl@0:     //!Equality operator -- others generated by boost::less_than_comparable
sl@0:     bool operator<(const time_type& rhs) const
sl@0:     {
sl@0:       return time_system::is_less(time_,rhs.time_);
sl@0:     }
sl@0:     //! difference between two times
sl@0:     time_duration_type operator-(const time_type& rhs) const
sl@0:     {
sl@0:       return time_system::subtract_times(time_, rhs.time_);
sl@0:     }
sl@0:     //! add date durations
sl@0:     time_type operator+(const date_duration_type& dd) const
sl@0:     {
sl@0:       return time_system::add_days(time_, dd);
sl@0:     }
sl@0:     time_type operator+=(const date_duration_type& dd)
sl@0:     {
sl@0:       time_ = (time_system::get_time_rep(date() + dd, time_of_day()));
sl@0:       return time_type(time_);
sl@0:     }
sl@0:     //! subtract date durations
sl@0:     time_type operator-(const date_duration_type& dd) const
sl@0:     {
sl@0:       return time_system::subtract_days(time_, dd);
sl@0:     }
sl@0:     time_type operator-=(const date_duration_type& dd)
sl@0:     {
sl@0:       time_ = (time_system::get_time_rep(date() - dd, time_of_day()));
sl@0:       return time_type(time_);
sl@0:     }
sl@0:     //! add time durations
sl@0:     time_type operator+(const time_duration_type& td) const
sl@0:     {
sl@0:       return time_type(time_system::add_time_duration(time_, td));
sl@0:     }
sl@0:     time_type operator+=(const time_duration_type& td)
sl@0:     {
sl@0:       time_ = (time_system::get_time_rep(date(), time_of_day() + td));
sl@0:       return time_type(time_);
sl@0:     }
sl@0:     //! subtract time durations
sl@0:     time_type operator-(const time_duration_type& rhs) const
sl@0:     {
sl@0:       return time_system::subtract_time_duration(time_, rhs);
sl@0:     }
sl@0:     time_type operator-=(const time_duration_type& td) 
sl@0:     {
sl@0:       time_ = (time_system::get_time_rep(date(), time_of_day() - td));
sl@0:       return time_type(time_);
sl@0:     }
sl@0:     
sl@0:   protected:
sl@0:     time_rep_type time_;
sl@0:   };
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: } } //namespace date_time::boost
sl@0: 
sl@0: 
sl@0: #endif
sl@0: