[#BloombergLP-bdlt-PackedCalendar_HolidayConstIterator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::PackedCalendar_HolidayConstIterator
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<bdlt_packedcalendar.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
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

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/difference_type.adoc[`difference_type`] 
| Iterator difference type.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/iterator_category.adoc[`iterator_category`] 
| Iterator category for this holiday iterator.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/pointer.adoc[`pointer`] 
| Iterator pointer type.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/reference.adoc[`reference`] 
| The star operator returns a `PackedCalendar_DateRef` _by_ _value_.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/value_type.adoc[`value_type`] 
| Iterator value type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/2constructor-0d.adoc[`PackedCalendar_HolidayConstIterator`]         [.small]#[constructor]#
| Create an iterator having the value of the specified `original` iterator.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/2destructor.adoc[`~PackedCalendar_HolidayConstIterator`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_assign.adoc[`operator=`] 
| Assign to this iterator the value of the specified `rhs` iterator, and return a reference providing modifiable access to this object.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_star.adoc[`operator*`] 
| Return a `PackedCalendar_DateRef` object that contains the date value of the holiday referenced by this iterator.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_inc.adoc[`operator++`] 
| Advance this iterator to the next holiday in the calendar.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_dec.adoc[`operator‐‐`] 
| Regress this iterator to the previous holiday in the calendar.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_ptr.adoc[`operator‐>`] 
| Return a date proxy for the holiday referenced by this iterator.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/operator_not_eq-093.adoc[BloombergLP::bdlt::operator!=]`
| Return `true` if `lhs` and `rhs` do not refer to the same holiday.
| `xref:BloombergLP/bdlt/operator_eq-050.adoc[BloombergLP::bdlt::operator==]`
| Return `true` if `lhs` and `rhs` refer to the same holiday.
| `xref:BloombergLP/bdlt/PackedCalendar.adoc[BloombergLP::bdlt::PackedCalendar]`
| Space‐efficient, value‐semantic repository of weekend and holiday information.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/operator_inc-09c.adoc[`operator++`]
| Advance `iterator` to the next holiday and return its previous value.
| xref:BloombergLP/bdlt/operator_dec-0e.adoc[`operator‐‐`]
| Regress `iterator` to the previous holiday and return its previous value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#