Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.
PrevUpHomeNext

Class template date_duration

boost::date_time::date_duration —

Duration type with date level resolution.

Synopsis

template<typename duration_rep_traits> 
class date_duration {
public:
  // types
  typedef duration_rep_traits::int_type  duration_rep_type;
  typedef duration_rep_traits::impl_type duration_rep;     

  // construct/copy/destruct
  date_duration(duration_rep);
  date_duration(special_values);
  date_duration(const date_duration< duration_rep_traits > &);

  // public member functions
  duration_rep get_rep() const;
  bool is_special() const;
  duration_rep_type days() const;
  bool operator==(const date_duration &) const;
  bool operator<(const date_duration &) const;
  date_duration operator-=(const date_duration &) ;
  date_duration operator+=(const date_duration &) ;
  date_duration operator-() const;
  date_duration< duration_rep_traits > operator/=(int) ;
  date_duration< duration_rep_traits > operator/(int) ;
  bool is_negative() const;

  // public static functions
  date_duration unit() ;
};

Description

date_duration construct/copy/destruct

  1. date_duration(duration_rep day_count);

    Construct from a day count. 

  2. date_duration(special_values sv);

    construct from special_values - only works when instantiated with duration_traits_adapted 

  3. date_duration(const date_duration< duration_rep_traits > & other);

    Construct from another date_duration (Copy Constructor).

date_duration public member functions

  1. duration_rep get_rep() const;

    returns days_ as it's instantiated type - used for streaming 

  2. bool is_special() const;
  3. duration_rep_type days() const;

    returns days as value, not object. 

  4. bool operator==(const date_duration & rhs) const;

    Equality. 

  5. bool operator<(const date_duration & rhs) const;

    Less. 

  6. date_duration operator-=(const date_duration & rhs) ;

    Subtract another duration -- result is signed. 

  7. date_duration operator+=(const date_duration & rhs) ;

    Add a duration -- result is signed. 

  8. date_duration operator-() const;

    unary- Allows for dd = -date_duration(2); -> dd == -2 

  9. date_duration< duration_rep_traits > operator/=(int divisor) ;

    Division operations on a duration with an integer. 

  10. date_duration< duration_rep_traits > operator/(int divisor) ;
  11. bool is_negative() const;

    return sign information

date_duration public static functions

  1. date_duration unit() ;

    Returns the smallest duration -- used by to calculate 'end'.

Copyright © 2001-2004 CrystalClear Software, Inc
PrevUpHomeNext