bdlt::PackedCalendar_BusinessDayConstIterator Class Reference

#include <bdlt_packedcalendar.h>

Detailed Description

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

See bdlt_packedcalendar

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
	PackedCalendar_BusinessDayConstIterator (const PackedCalendar_BusinessDayConstIterator &original)
	~PackedCalendar_BusinessDayConstIterator ()
PackedCalendar_BusinessDayConstIterator &	operator= (const PackedCalendar_BusinessDayConstIterator &rhs)
PackedCalendar_BusinessDayConstIterator &	operator++ ()
PackedCalendar_BusinessDayConstIterator &	operator-- ()
PackedCalendar_DateRef	operator* () const
PackedCalendar_DateProxy	operator-> () const

Friends
class	PackedCalendar
bool	operator== (const PackedCalendar_BusinessDayConstIterator &, const PackedCalendar_BusinessDayConstIterator &)
bool	operator!= (const PackedCalendar_BusinessDayConstIterator &, const PackedCalendar_BusinessDayConstIterator &)

Member Typedef Documentation

difference_type

typedef int bdlt::PackedCalendar_BusinessDayConstIterator::difference_type

iterator_category

typedef bsl::bidirectional_iterator_tag bdlt::PackedCalendar_BusinessDayConstIterator::iterator_category

pointer

typedef PackedCalendar_DateProxy bdlt::PackedCalendar_BusinessDayConstIterator::pointer

reference

typedef PackedCalendar_DateRef bdlt::PackedCalendar_BusinessDayConstIterator::reference

The star operator returns a PackedCalendar_DateRef by value.

value_type

typedef Date bdlt::PackedCalendar_BusinessDayConstIterator::value_type

Constructor & Destructor Documentation

PackedCalendar_BusinessDayConstIterator()

bdlt::PackedCalendar_BusinessDayConstIterator::PackedCalendar_BusinessDayConstIterator ( const PackedCalendar_BusinessDayConstIterator &  original )

inline

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

~PackedCalendar_BusinessDayConstIterator()

bdlt::PackedCalendar_BusinessDayConstIterator::~PackedCalendar_BusinessDayConstIterator ( )

inline

Destroy this object.

Member Function Documentation

operator*()

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

inline

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

operator++()

PackedCalendar_BusinessDayConstIterator & bdlt::PackedCalendar_BusinessDayConstIterator::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--()

PackedCalendar_BusinessDayConstIterator & bdlt::PackedCalendar_BusinessDayConstIterator::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::PackedCalendar_BusinessDayConstIterator::operator-> ( ) const

inline

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

operator=()

PackedCalendar_BusinessDayConstIterator & bdlt::PackedCalendar_BusinessDayConstIterator::operator=

(

const PackedCalendar_BusinessDayConstIterator &

rhs

)

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

operator!=

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

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 PackedCalendar_BusinessDayConstIterator &  , const PackedCalendar_BusinessDayConstIterator &    )

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.

PackedCalendar

friend class PackedCalendar

friend

---

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

• bdlt_packedcalendar.h