CLASS TEMPLATE(3)

NAME
boost::date_time::date_itr_base - Base date iterator type.

SYNOPSIS

// In header: <boost/date_time/date_iterator.hpp>
template<typename date_type>
class date_itr_base {
public:
  // types
  typedef date_type::duration_type duration_type;
  typedef date_type                value_type;
  typedef std::input_iterator_tag  iterator_category;
  // construct/copy/destruct
  date_itr_base(date_type);
  ~date_itr_base();
  // public member functions
  date_itr_base & operator++();
  date_itr_base & operator--();
  duration_type get_offset(const date_type &) const;
  duration_type get_neg_offset(const date_type &) const;
  date_type operator*();
  date_type * operator->();
  bool operator<(const date_type &);
  bool operator<=(const date_type &);
  bool operator>(const date_type &);
  bool operator>=(const date_type &);
  bool operator==(const date_type &);
  bool operator!=(const date_type &);
};

DESCRIPTION

This class provides the skeleton for the creation of iterators. New and interesting interators can be created by plugging in a new function that derives the next value from the current state. generation of various types of -based information.

Template Parameters

date_type

The date_type is a concrete date_type. The date_type must define a duration_type and a calendar_type.

  date_itr_base public construct/copy/destruct

    1.

    date_itr_base(date_type d);

    2.

    ~date_itr_base();

  date_itr_base public member functions

    1.

    date_itr_base & operator++();

    2.

    date_itr_base & operator--();

    3.

    duration_type get_offset(const date_type & current) const;

    4.

    duration_type get_neg_offset(const date_type & current) const;

    5.

    date_type operator*();

    6.

    date_type * operator->();

    7.

    bool operator<(const date_type & d);

    8.

    bool operator<=(const date_type & d);

    9.

    bool operator>(const date_type & d);

    10.

    bool operator>=(const date_type & d);

    11.

    bool operator==(const date_type & d);

    12.

    bool operator!=(const date_type & d);