bdlt::Calendar_BusinessDayConstIter Class Reference

#include <bdlt_calendar.h>

Detailed Description

Provide read-only, sequential access in increasing (chronological) order to the business days in a Calendar object.

See bdlt_calendar

Public Types
typedef Date	value_type
typedef int	difference_type
typedef PackedCalendar_DateProxy	pointer
typedef PackedCalendar_DateRef	reference
typedef bsl::bidirectional_iterator_tag	iterator_category

Public Member Functions
	Calendar_BusinessDayConstIter (const Calendar_BusinessDayConstIter &original)
	~Calendar_BusinessDayConstIter ()
Calendar_BusinessDayConstIter &	operator= (const Calendar_BusinessDayConstIter &rhs)
Calendar_BusinessDayConstIter &	operator++ ()
Calendar_BusinessDayConstIter &	operator-- ()
PackedCalendar_DateRef	operator* () const
PackedCalendar_DateProxy	operator-> () const

Friends
class	Calendar
bool	operator== (const Calendar_BusinessDayConstIter &, const Calendar_BusinessDayConstIter &)
bool	operator!= (const Calendar_BusinessDayConstIter &, const Calendar_BusinessDayConstIter &)

Member Typedef Documentation

difference_type

typedef int bdlt::Calendar_BusinessDayConstIter::difference_type

iterator_category

typedef bsl::bidirectional_iterator_tag bdlt::Calendar_BusinessDayConstIter::iterator_category

pointer

typedef PackedCalendar_DateProxy bdlt::Calendar_BusinessDayConstIter::pointer

reference

typedef PackedCalendar_DateRef bdlt::Calendar_BusinessDayConstIter::reference

The star operator returns a PackedCalendar_DateRef by value.

value_type

typedef Date bdlt::Calendar_BusinessDayConstIter::value_type

Constructor & Destructor Documentation

Calendar_BusinessDayConstIter()

bdlt::Calendar_BusinessDayConstIter::Calendar_BusinessDayConstIter ( const Calendar_BusinessDayConstIter &  original )

inline

Create an iterator having the value of the specified original iterator.

~Calendar_BusinessDayConstIter()

bdlt::Calendar_BusinessDayConstIter::~Calendar_BusinessDayConstIter ( )

inline

Destroy this object.

Member Function Documentation

operator*()

PackedCalendar_DateRef bdlt::Calendar_BusinessDayConstIter::operator* ( ) const

inline

Return a PackedCalendar_DateRef object that contains the date value of the business day referenced by this iterator.

operator++()

Calendar_BusinessDayConstIter & bdlt::Calendar_BusinessDayConstIter::operator++ ( )

inline

Advance this iterator to refer to the next business day in the associated calendar, and return a reference providing modifiable access to this object.

Precondition

The behavior is undefined unless, on entry, this iterator references a valid business day.

operator--()

Calendar_BusinessDayConstIter & bdlt::Calendar_BusinessDayConstIter::operator-- ( )

inline

Regress this iterator to refer to the previous business day in the associated calendar, and return a reference providing modifiable access to this object.

Precondition

The behavior is undefined unless, on entry, this iterator references a valid business day that is not the first business day for the associated calendar.

operator->()

PackedCalendar_DateProxy bdlt::Calendar_BusinessDayConstIter::operator-> ( ) const

inline

Return a date proxy for the business day referenced by this iterator.

operator=()

Calendar_BusinessDayConstIter & bdlt::Calendar_BusinessDayConstIter::operator= ( const Calendar_BusinessDayConstIter &  rhs )

inline

Assign to this iterator the value of the specified rhs iterator, and return a reference providing modifiable access to this object.

Friends And Related Symbol Documentation

Calendar

friend class Calendar

friend

operator!=

bool operator!= ( const Calendar_BusinessDayConstIter &  , const Calendar_BusinessDayConstIter &    )

friend

Return true if the specified lhs and rhs iterators do not refer to the same element in the same calendar, and false otherwise.

Precondition

The behavior is undefined unless lhs and rhs both iterate over the same calendar.

operator==

bool operator== ( const Calendar_BusinessDayConstIter &  , const Calendar_BusinessDayConstIter &    )

friend

Return true if the specified lhs and rhs iterators refer to the same element in the same calendar, and false otherwise.

Precondition

The behavior is undefined unless lhs and rhs both iterate over the same calendar.

---

The documentation for this class was generated from the following file:

• bdlt_calendar.h