[#BloombergLP-bdlt-PackedCalendar_HolidayConstIterator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::PackedCalendar&lowbar;HolidayConstIterator
:relfileprefix: ../../
:mrdocs:

Sequential, read&hyphen;only iterator over holidays in a `PackedCalendar`&period;

== Synopsis

Declared in `&lt;bdlt&lowbar;packedcalendar&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class PackedCalendar&lowbar;HolidayConstIterator;
----

== Description

Provide read&hyphen;only, sequential access in increasing (chronological) order to the holidays in a `PackedCalendar` object&period; This class owns an iterator into the `bdlc&colon;&colon;PackedIntArray` storing the holiday offsets of the referenced `bdlt&colon;&colon;PackedCalendar` and a date, `d&lowbar;firstDate`, to convert the offsets into dates corresponding to holidays&period;

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/2constructor-0d.adoc[`PackedCalendar&lowbar;HolidayConstIterator`]         [.small]#[constructor]#
| Create an iterator having the value of the specified `original` iterator&period;
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/2destructor.adoc[`&#126;PackedCalendar&lowbar;HolidayConstIterator`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_assign.adoc[`operator&equals;`] 
| Assign to this iterator the value of the specified `rhs` iterator, and return a reference providing modifiable access to this object&period;
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_star.adoc[`operator&ast;`] 
| Return a `PackedCalendar&lowbar;DateRef` object that contains the date value of the holiday referenced by this iterator&period;
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_inc.adoc[`operator&plus;&plus;`] 
| Advance this iterator to the next holiday in the calendar&period;
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_dec.adoc[`operator&hyphen;&hyphen;`] 
| Regress this iterator to the previous holiday in the calendar&period;
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator/operator_ptr.adoc[`operator&hyphen;&gt;`] 
| Return a date proxy for the holiday referenced by this iterator&period;
|===


== Friends

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

== Non-Member Functions

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


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