Sequential, read‐only iterator over holidays in a PackedCalendar.

Synopsis

Declared in <bdlt_packedcalendar.h>

class PackedCalendar_HolidayConstIterator;

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.

Type Aliases

Name

Description

difference_type

Iterator difference type.

iterator_category

Iterator category for this holiday iterator.

pointer

Iterator pointer type.

reference

The star operator returns a PackedCalendar_DateRef by value.

value_type

Iterator value type.

Member Functions

Name

Description

PackedCalendar_HolidayConstIterator [constructor]

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

~PackedCalendar_HolidayConstIterator [destructor]

Destroy this object.

operator=

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

operator*

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

operator++

Advance this iterator to the next holiday in the calendar.

operator‐‐

Regress this iterator to the previous holiday in the calendar.

operator‐>

Return a date proxy for the holiday referenced by this iterator.

Friends

Name

Description

BloombergLP::bdlt::operator!=

Return true if lhs and rhs do not refer to the same holiday.

BloombergLP::bdlt::operator==

Return true if lhs and rhs refer to the same holiday.

BloombergLP::bdlt::PackedCalendar

Space‐efficient, value‐semantic repository of weekend and holiday information.

Non-Member Functions

Name

Description

operator++

Advance iterator to the next holiday and return its previous value.

operator‐‐

Regress iterator to the previous holiday and return its previous value.

Created with MrDocs