bdlt::Timetable_ConstIterator Class Reference

#include <bdlt_timetable.h>

Detailed Description

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

See bdlt_timetable

Public Types
typedef TimetableTransition	value_type
typedef TimetableTransition_Ref *	pointer
typedef TimetableTransition	reference

Public Member Functions
	Timetable_ConstIterator ()
	Timetable_ConstIterator (const Timetable_ConstIterator &original)
	~Timetable_ConstIterator ()=default
Timetable_ConstIterator &	operator= (const Timetable_ConstIterator &rhs)
Timetable_ConstIterator &	operator++ ()
Timetable_ConstIterator &	operator-- ()
TimetableTransition	operator* () const
const TimetableTransition_Ref *	operator-> () const

Friends
class	Timetable
bool	operator== (const Timetable_ConstIterator &, const Timetable_ConstIterator &)
bool	operator!= (const Timetable_ConstIterator &, const Timetable_ConstIterator &)

Member Typedef Documentation

pointer

typedef TimetableTransition_Ref* bdlt::Timetable_ConstIterator::pointer

reference

typedef TimetableTransition bdlt::Timetable_ConstIterator::reference

The star operator returns a TimetableTransition by value.

value_type

typedef TimetableTransition bdlt::Timetable_ConstIterator::value_type

Constructor & Destructor Documentation

Timetable_ConstIterator() [1/2]

bdlt::Timetable_ConstIterator::Timetable_ConstIterator ( )

inline

Create a default iterator.

Note

Note that the behavior of most methods is undefined when used on a default-constructed iterator.

Timetable_ConstIterator() [2/2]

bdlt::Timetable_ConstIterator::Timetable_ConstIterator ( const Timetable_ConstIterator &  original )

inline

Create an iterator having the value of the specified original iterator.

~Timetable_ConstIterator()

bdlt::Timetable_ConstIterator::~Timetable_ConstIterator ( )

default

Member Function Documentation

operator*()

TimetableTransition bdlt::Timetable_ConstIterator::operator* ( ) const

inline

Return, by value, a TimetableTransition object representing the transition referenced by this iterator.

Precondition

The behavior is undefined unless this iterator references a valid transition in the associated timetable.

operator++()

Timetable_ConstIterator & bdlt::Timetable_ConstIterator::operator++

(

)

Advance this iterator to refer to the next transition in the associated timetable, and return a reference providing modifiable access to this object.

Precondition

The behavior is undefined unless, on entry, this iterator references a valid transition.

operator--()

Timetable_ConstIterator & bdlt::Timetable_ConstIterator::operator--

(

)

Regress this iterator to refer to the previous transition in the associated timetable, and return a reference providing modifiable access to this object.

Precondition

The behavior is undefined unless, on entry, this iterator references a valid transition that is not the first transition of the associated timetable.

operator->()

const TimetableTransition_Ref * bdlt::Timetable_ConstIterator::operator-> ( ) const

inline

Return a proxy to the transition referenced by this iterator.

Precondition

The behavior is undefined unless this iterator references a valid transition in the associated timetable.

operator=()

Timetable_ConstIterator & bdlt::Timetable_ConstIterator::operator= ( const Timetable_ConstIterator &  rhs )

inline

Assign to this iterator the value of the specified rhs iterator, and return a reference providing modifiable access to this object.

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const Timetable_ConstIterator &  , const Timetable_ConstIterator &    )

friend

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.

operator==

bool operator== ( const Timetable_ConstIterator &  , const Timetable_ConstIterator &    )

friend

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.

Timetable

friend class Timetable

friend

---

The documentation for this class was generated from the following file:

• bdlt_timetable.h