bdlt::PackedCalendar_HolidayCodeConstIterator Class Reference

#include <bdlt_packedcalendar.h>

Detailed Description

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

See bdlt_packedcalendar

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

Member Typedef Documentation

difference_type

typedef int bdlt::PackedCalendar_HolidayCodeConstIterator::difference_type

iterator_category

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

pointer

typedef int* bdlt::PackedCalendar_HolidayCodeConstIterator::pointer

reference

typedef int bdlt::PackedCalendar_HolidayCodeConstIterator::reference

The star operator returns an int by value.

value_type

typedef int bdlt::PackedCalendar_HolidayCodeConstIterator::value_type

Constructor & Destructor Documentation

PackedCalendar_HolidayCodeConstIterator()

bdlt::PackedCalendar_HolidayCodeConstIterator::PackedCalendar_HolidayCodeConstIterator ( const PackedCalendar_HolidayCodeConstIterator &  original )

inline

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

~PackedCalendar_HolidayCodeConstIterator()

bdlt::PackedCalendar_HolidayCodeConstIterator::~PackedCalendar_HolidayCodeConstIterator ( )

inline

Destroy this object.

Member Function Documentation

operator*()

int bdlt::PackedCalendar_HolidayCodeConstIterator::operator* ( ) const

inline

Return the holiday code referenced by this iterator.

operator++()

PackedCalendar_HolidayCodeConstIterator & bdlt::PackedCalendar_HolidayCodeConstIterator::operator++ ( )

inline

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.

Precondition

The behavior is undefined unless, on entry, this iterator references a valid holiday code.

operator--()

PackedCalendar_HolidayCodeConstIterator & bdlt::PackedCalendar_HolidayCodeConstIterator::operator-- ( )

inline

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.

Precondition

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.

operator=()

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

inline

Assign to this object 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_HolidayCodeConstIterator &  , const PackedCalendar_HolidayCodeConstIterator &    )

friend

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

Precondition

The behavior is undefined unless lhs and rhs both reference the same holiday in the same calendar.

operator-

bsl::ptrdiff_t operator- ( const PackedCalendar_HolidayCodeConstIterator &  , const PackedCalendar_HolidayCodeConstIterator &    )

friend

Return the number of elements between specified lhs and rhs.

Precondition

The behavior is undefined unless lhs and rhs refer to codes associated with the same holiday in the same calendar.

operator==

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.

Precondition

The behavior is undefined unless lhs and rhs both reference the same holiday in the same calendar.

PackedCalendar

friend class PackedCalendar

friend

---

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

• bdlt_packedcalendar.h