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

Provide read‐only, sequential access in increasing (chronological) order to the transitions in a `Timetable` object.

== Synopsis

Declared in `<bdlt_timetable.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/Timetable_ConstIterator/pointer.adoc[`pointer`] 
| 
| xref:BloombergLP/bdlt/Timetable_ConstIterator/reference.adoc[`reference`] 
| The star operator returns a `TimetableTransition` _by_ _value_.
| xref:BloombergLP/bdlt/Timetable_ConstIterator/value_type.adoc[`value_type`] 
| 
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/Timetable_ConstIterator/2constructor-09.adoc[`Timetable_ConstIterator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlt/Timetable_ConstIterator/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/Timetable_ConstIterator/operator_star.adoc[`operator*`] 
| Return, _by_ _value_, a `TimetableTransition` object representing the transition referenced by this iterator. The behavior is undefined unless this iterator references a valid transition in the associated timetable.
| xref:BloombergLP/bdlt/Timetable_ConstIterator/operator_inc.adoc[`operator++`] 
| Advance this iterator to refer to the next transition in the associated timetable, and return a reference providing modifiable access to this object. The behavior is undefined unless, on entry, this iterator references a valid transition.
| xref:BloombergLP/bdlt/Timetable_ConstIterator/operator_dec.adoc[`operator‐‐`] 
| Regress this iterator to refer to the previous transition in the associated timetable, and return a reference providing modifiable access to this object. The behavior is undefined unless, on entry, this iterator references a valid transition that is not the first transition of the associated timetable.
| xref:BloombergLP/bdlt/Timetable_ConstIterator/operator_ptr.adoc[`operator‐>`] 
| Return a proxy to the transition referenced by this iterator. The behavior is undefined unless this iterator references a valid transition in the associated timetable.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlt/operator_not_eq-00.adoc[BloombergLP::bdlt::operator!=]`
| Return `true` if the specified `lhs` and `rhs` iterators do not have the same value, and `false` otherwise. Two `Timetable_ConstIterator` iterators do not have the same value if they do not refer to the same timetable, or do not refer to the same transition.
| `xref:BloombergLP/bdlt/operator_eq-09d.adoc[BloombergLP::bdlt::operator==]`
| Return `true` if the specified `lhs` and `rhs` iterators have the same value, and `false` otherwise. Two `Timetable_ConstIterator` iterators have the same value if they refer to the same timetable and the same transition.
| `xref:BloombergLP/bdlt/Timetable.adoc[BloombergLP::bdlt::Timetable]`
| This class implements a value‐semantic repository of datetime‐indexed state transitions over a _valid_ _range_ of dates. This valid range, `[firstDate() .. lastDate()]`, spans the first and last dates of a timetable's accessible contents. A timetable can be "populated" with state transitions via a suite of "add" methods. Note that the behavior of requesting _any_ timetable information for a supplied date whose value is outside the current _valid_ _range_ for that timetable is undefined.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/operator_inc-0b.adoc[`operator++`]
| Advance the specified `iterator` to refer to the next transition in the referenced timetable, and return an iterator referring to the original element (_before_ the advancement). The behavior is undefined unless, on entry, `iterator` references a valid transition.
| xref:BloombergLP/bdlt/operator_dec-0b.adoc[`operator‐‐`]
| Regress the specified `iterator` to refer to the previous transition in the referenced timetable, and return an iterator referring to the original element (_before_ the decrementation). The behavior is undefined unless, on entry, `iterator` references a valid transition that is not the first transition of the associated timetable.
|===


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