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

Provide read&hyphen;only, sequential access in increasing (numerical) order to the holiday codes in a `PackedCalendar` object&period;

== Synopsis

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

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

== Type Aliases

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


== Member Functions

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


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/operator_minus-094.adoc[BloombergLP::bdlt::operator&hyphen;]`
| Return the number of holiday codes between `lhs` and `rhs`&period;
| `xref:BloombergLP/bdlt/operator_not_eq-06b.adoc[BloombergLP::bdlt::operator!&equals;]`
| Return `true` if `lhs` and `rhs` do not refer to the same holiday code&period;
| `xref:BloombergLP/bdlt/operator_eq-0a4.adoc[BloombergLP::bdlt::operator&equals;&equals;]`
| Return `true` if `lhs` and `rhs` refer to the same holiday code&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-0af.adoc[`operator&plus;&plus;`]
| Advance `iterator` to the next holiday code and return its previous value&period;
| xref:BloombergLP/bdlt/operator_dec-02.adoc[`operator&hyphen;&hyphen;`]
| Regress `iterator` to the previous holiday code and return its previous value&period;
|===


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