bdlt::PackedCalendar_HolidayCodeConstIterator Class Reference

#include <bdlt_packedcalendar.h>

List of all members.

Public Types
typedef int	value_type
typedef int	difference_type
typedef int *	pointer
typedef int	reference
typedef bsl::bidirectional_iterator_tag	iterator_category
Public Member Functions
	PackedCalendar_HolidayCodeConstIterator (const PackedCalendar_HolidayCodeConstIterator &original)
	~PackedCalendar_HolidayCodeConstIterator ()
PackedCalendar_HolidayCodeConstIterator &	operator= (const PackedCalendar_HolidayCodeConstIterator &rhs)
PackedCalendar_HolidayCodeConstIterator &	operator++ ()
PackedCalendar_HolidayCodeConstIterator &	operator-- ()
int	operator* () const
Friends
class	PackedCalendar
bool	operator== (const PackedCalendar_HolidayCodeConstIterator &, const PackedCalendar_HolidayCodeConstIterator &)
bool	operator!= (const PackedCalendar_HolidayCodeConstIterator &, const PackedCalendar_HolidayCodeConstIterator &)
bsl::ptrdiff_t	operator- (const PackedCalendar_HolidayCodeConstIterator &, const PackedCalendar_HolidayCodeConstIterator &)

---

Detailed Description

Provide read-only, sequential access in increasing (numerical) order to the holiday codes in a PackedCalendar object.

See Component bdlt_packedcalendar

---

Member Typedef Documentation

typedef int bdlt::PackedCalendar_HolidayCodeConstIterator::value_type

typedef int bdlt::PackedCalendar_HolidayCodeConstIterator::difference_type

typedef int* bdlt::PackedCalendar_HolidayCodeConstIterator::pointer

typedef int bdlt::PackedCalendar_HolidayCodeConstIterator::reference

typedef bsl::bidirectional_iterator_tag bdlt::PackedCalendar_HolidayCodeConstIterator::iterator_category

---

Constructor & Destructor Documentation

bdlt::PackedCalendar_HolidayCodeConstIterator::PackedCalendar_HolidayCodeConstIterator

(

const PackedCalendar_HolidayCodeConstIterator &

original

)

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

bdlt::PackedCalendar_HolidayCodeConstIterator::~PackedCalendar_HolidayCodeConstIterator

(

)

Destroy this object.

---

Member Function Documentation

PackedCalendar_HolidayCodeConstIterator& bdlt::PackedCalendar_HolidayCodeConstIterator::operator=

(

const PackedCalendar_HolidayCodeConstIterator &

rhs

)

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

PackedCalendar_HolidayCodeConstIterator& bdlt::PackedCalendar_HolidayCodeConstIterator::operator++

(

)

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

PackedCalendar_HolidayCodeConstIterator& bdlt::PackedCalendar_HolidayCodeConstIterator::operator--

(

)

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

int bdlt::PackedCalendar_HolidayCodeConstIterator::operator*

(

)

const

Return the holiday code referenced by this iterator.

---

Friends And Related Function Documentation

friend class PackedCalendar [friend]

bool operator==	(	const PackedCalendar_HolidayCodeConstIterator &	,
		const PackedCalendar_HolidayCodeConstIterator &
	)			[friend]

Return true if the specified lhs and rhs iterators refers to the same element, and false otherwise. The behavior is undefined unless lhs and rhs both reference the same holiday in the same calendar.

bool operator!=	(	const PackedCalendar_HolidayCodeConstIterator &	,
		const PackedCalendar_HolidayCodeConstIterator &
	)			[friend]

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

bsl::ptrdiff_t operator-	(	const PackedCalendar_HolidayCodeConstIterator &	,
		const PackedCalendar_HolidayCodeConstIterator &
	)			[friend]

Return the number of elements between specified lhs and rhs. The behavior is undefined unless lhs and rhs refer to codes associated with the same holiday in the same calendar.

---

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

• bdlt_packedcalendar.h