[#BloombergLP-bdlt-Calendar_BusinessDayConstIter]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::Calendar&lowbar;BusinessDayConstIter
:relfileprefix: ../../
:mrdocs:

Provide read&hyphen;only, sequential access in increasing (chronological) order to the business days in a `Calendar` object&period;

== Synopsis

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

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/difference_type.adoc[`difference&lowbar;type`] 
| Signed integral type used to represent the distance between iterators&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/iterator_category.adoc[`iterator&lowbar;category`] 
| Iterator category for this business&hyphen;day iterator&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/pointer.adoc[`pointer`] 
| Proxy pointer type returned by this iterator&apos;s `operator&hyphen;&gt;`&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/reference.adoc[`reference`] 
| The star operator returns a `PackedCalendar&lowbar;DateRef` _by_ _value_&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/value_type.adoc[`value&lowbar;type`] 
| Type of each element referenced by this iterator&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/2constructor.adoc[`Calendar&lowbar;BusinessDayConstIter`]         [.small]#[constructor]#
| Create an iterator having the value of the specified `original` iterator&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/2destructor.adoc[`&#126;Calendar&lowbar;BusinessDayConstIter`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/operator_assign.adoc[`operator&equals;`] 
| Assign to this iterator the value of the specified `rhs` iterator&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/operator_star.adoc[`operator&ast;`] 
| Return a `PackedCalendar&lowbar;DateRef` object that contains the date value of the business day referenced by this iterator&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/operator_inc.adoc[`operator&plus;&plus;`] 
| Advance this iterator to the next business day&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/operator_dec.adoc[`operator&hyphen;&hyphen;`] 
| Regress this iterator to the previous business day&period;
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/operator_ptr.adoc[`operator&hyphen;&gt;`] 
| Return a date proxy for the business day referenced by this iterator&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/operator_not_eq-07b.adoc[BloombergLP::bdlt::operator!&equals;]`
| Return `true` if `lhs` and `rhs` do not refer to the same element&period;
| `xref:BloombergLP/bdlt/operator_eq-0a9.adoc[BloombergLP::bdlt::operator&equals;&equals;]`
| Return `true` if `lhs` and `rhs` refer to the same calendar element&period;
| `xref:BloombergLP/bdlt/Calendar.adoc[BloombergLP::bdlt::Calendar]`
| Runtime&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-0ad.adoc[`operator&plus;&plus;`]
| Advance `iterator` to the next business day and return its prior value&period;
| xref:BloombergLP/bdlt/operator_dec-052.adoc[`operator&hyphen;&hyphen;`]
| Regress `iterator` to the previous business day and return its prior value&period;
|===


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