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.

Synopsis

Declared in <bdlt_packedcalendar.h>

class PackedCalendar_HolidayConstIterator;

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

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

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

Friends

Name

Description

BloombergLP::bdlt::operator!=

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.

BloombergLP::bdlt::operator==

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.

BloombergLP::bdlt::PackedCalendar

This class implements a space‐efficient, value‐semantic repository of weekend and holiday information over a valid range of dates. This valid range, [firstDate() .. lastDate()], spans the first and last dates of a calendar's accessible contents. A calendar can be "populated" with weekend and holiday information via a suite of "add" methods. Any subset of days of the week may be specified as weekend (i.e., recurring non‐business) days starting from a specified date by adding a weekend‐days transition; holidays within the valid range are specified individually. When adding a holiday, an arbitrary integer "holiday code" may be associated with that date. Additional holiday codes for that date may subsequently be added. Both the holidays and the set of unique holiday codes associated with each holiday date are maintained (internally) in order of increasing value. Note that the behavior of requesting any calendar information for a supplied date whose value is outside the current valid range for that calendar (unless otherwise noted, e.g., isWeekendDay) is undefined.

Non-Member Functions

Name

Description

operator++

Advance the specified iterator to refer to the next holiday in the associated calendar, and return the previous value of iterator. The behavior is undefined unless, on entry, iterator references a valid holiday.

operator‐‐

Regress the specified iterator to refer to the previous holiday in the associated calendar, and return the previous value of iterator. The behavior is undefined unless, on entry, iterator references a valid holiday that is not the first holiday in the associated calendar.

Created with MrDocs