bdlt::PackedCalendar_HolidayConstIterator Class Reference

#include <bdlt_packedcalendar.h>

Public Types
typedef Date	value_type
typedef int	difference_type
typedef PackedCalendar_DateProxy	pointer
typedef PackedCalendar_DateRef	reference
	The star operator returns a PackedCalendar_DateRef by value.
typedef bsl::bidirectional_iterator_tag	iterator_category

Public Member Functions
	PackedCalendar_HolidayConstIterator (const PackedCalendar_HolidayConstIterator &original)
	~PackedCalendar_HolidayConstIterator ()
	Destroy this object.
PackedCalendar_HolidayConstIterator &	operator= (const PackedCalendar_HolidayConstIterator &rhs)
PackedCalendar_HolidayConstIterator &	operator++ ()
PackedCalendar_HolidayConstIterator &	operator-- ()
PackedCalendar_DateRef	operator* () const
PackedCalendar_DateProxy	operator-> () const
	Return a date proxy for the holiday referenced by this iterator.

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

Detailed Description

Provide read-only, sequential access in increasing (chronological) order to the holidays in a PackedCalendar object. This class owns an iterator into the bdlc::PackedIntArray storing the holiday offsets of the referenced bdlt::PackedCalendar and a date, d_firstDate, to convert the offsets into dates corresponding to holidays.

See bdlt_packedcalendar

Member Typedef Documentation

difference_type

typedef int bdlt::PackedCalendar_HolidayConstIterator::difference_type

iterator_category

typedef bsl::bidirectional_iterator_tag bdlt::PackedCalendar_HolidayConstIterator::iterator_category

pointer

typedef PackedCalendar_DateProxy bdlt::PackedCalendar_HolidayConstIterator::pointer

reference

typedef PackedCalendar_DateRef bdlt::PackedCalendar_HolidayConstIterator::reference

value_type

typedef Date bdlt::PackedCalendar_HolidayConstIterator::value_type

Constructor & Destructor Documentation

PackedCalendar_HolidayConstIterator()

bdlt::PackedCalendar_HolidayConstIterator::PackedCalendar_HolidayConstIterator ( const PackedCalendar_HolidayConstIterator &  original )

inline

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

~PackedCalendar_HolidayConstIterator()

bdlt::PackedCalendar_HolidayConstIterator::~PackedCalendar_HolidayConstIterator ( )

inline

Member Function Documentation

operator*()

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

inline

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

operator++()

PackedCalendar_HolidayConstIterator & bdlt::PackedCalendar_HolidayConstIterator::operator++ ( )

inline

Advance this iterator to refer to the next holiday in the calendar, and return a reference providing modifiable access to this object. The behavior is undefined unless, on entry, this iterator references a valid holiday.

operator--()

PackedCalendar_HolidayConstIterator & bdlt::PackedCalendar_HolidayConstIterator::operator-- ( )

inline

Regress this iterator to refer to the previous holiday in the calendar, and return a reference providing modifiable access to this object. The behavior is undefined unless, on entry, this iterator references a valid holiday that is not the first holiday in the associated calendar.

operator->()

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

inline

operator=()

PackedCalendar_HolidayConstIterator & bdlt::PackedCalendar_HolidayConstIterator::operator= ( const PackedCalendar_HolidayConstIterator &  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

operator!=

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

friend

Return true if the specified lhs and rhs iterators do not refer to the same element in the same calendar, and false otherwise. The behavior is undefined unless lhs and rhs both iterate over the same calendar.

operator==

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

friend

Return true if the specified lhs and rhs iterators refer to the same element in the same calendar, and false otherwise. 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