bdlt::Calendar_BusinessDayConstIter Class Reference

#include <bdlt_calendar.h>

List of all members.

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 &)

---

Detailed Description

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

See Component bdlt_calendar

---

Member Typedef Documentation

typedef Date bdlt::Calendar_BusinessDayConstIter::value_type

typedef int bdlt::Calendar_BusinessDayConstIter::difference_type

typedef PackedCalendar_DateProxy bdlt::Calendar_BusinessDayConstIter::pointer

typedef PackedCalendar_DateRef bdlt::Calendar_BusinessDayConstIter::reference

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

---

Constructor & Destructor Documentation

bdlt::Calendar_BusinessDayConstIter::Calendar_BusinessDayConstIter

(

const Calendar_BusinessDayConstIter &

original

)

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

bdlt::Calendar_BusinessDayConstIter::~Calendar_BusinessDayConstIter

(

)

Destroy this object.

---

Member Function Documentation

Calendar_BusinessDayConstIter& bdlt::Calendar_BusinessDayConstIter::operator=

(

const Calendar_BusinessDayConstIter &

rhs

)

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

Calendar_BusinessDayConstIter& bdlt::Calendar_BusinessDayConstIter::operator++

(

)

Advance this iterator to refer to the next business day 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 business day.

Calendar_BusinessDayConstIter& bdlt::Calendar_BusinessDayConstIter::operator--

(

)

Regress this iterator to refer to the previous business day 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 business day that is not the first business day for the associated calendar.

PackedCalendar_DateRef bdlt::Calendar_BusinessDayConstIter::operator*

(

)

const

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

PackedCalendar_DateProxy bdlt::Calendar_BusinessDayConstIter::operator->

(

)

const

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

---

Friends And Related Function Documentation

friend class Calendar [friend]

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. The behavior is undefined unless lhs and rhs both iterate over the same calendar.

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. 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