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

Provide read‐only, sequential access in increasing (chronological) order to the business days in a `Calendar` object.

== Synopsis

Declared in `<bdlt_calendar.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Calendar_BusinessDayConstIter;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/difference_type.adoc[`difference_type`] 
| Signed integral type used to represent the distance between iterators.
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/iterator_category.adoc[`iterator_category`] 
| Iterator category for this business‐day iterator.
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/pointer.adoc[`pointer`] 
| Proxy pointer type returned by this iterator's `operator‐>`.
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/reference.adoc[`reference`] 
| The star operator returns a `PackedCalendar_DateRef` _by_ _value_.
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter/value_type.adoc[`value_type`] 
| Type of each element referenced by this iterator.
|===


== Member Functions

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


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/operator_not_eq-07b.adoc[BloombergLP::bdlt::operator!=]`
| Return `true` if `lhs` and `rhs` do not refer to the same element.
| `xref:BloombergLP/bdlt/operator_eq-0a9.adoc[BloombergLP::bdlt::operator==]`
| Return `true` if `lhs` and `rhs` refer to the same calendar element.
| `xref:BloombergLP/bdlt/Calendar.adoc[BloombergLP::bdlt::Calendar]`
| Runtime‐efficient, value‐semantic repository of weekend and holiday information.
|===

== Non-Member Functions

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


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