PUBLIC

BaseBodyConstDLIterC::Data(void) const BaseBodyConstDLIterC::operator*(void) const BaseBodyConstDLIterC::operator->(void) const BaseBodyConstDLIterC::NextData(void) const BaseBodyConstDLIterC::PrevData(void) const BaseBodyConstDLIterC::NextCrcData(void) const BaseBodyConstDLIterC::PrevCrcData(void) const BaseBodyConstDLIterC::NextData(int) const BaseBodyConstDLIterC::PrevData(int) const BaseBodyConstDLIterC::NextCrcData(int) const BaseBodyConstDLIterC::PrevCrcData(int) const BaseBodyConstDLIterC::List(void) const BaseBodyConstDLIterC::operator==(const BaseBodyConstDLIterC &) const BaseBodyConstDLIterC::operator!=(const BaseBodyConstDLIterC &) const BaseBodyConstDLIterC::IsFirst(void) const BaseBodyConstDLIterC::IsLast(void) const BaseBodyConstDLIterC::IsElm(void) const BaseBodyConstDLIterC::First(void) BaseBodyConstDLIterC::Last(void) BaseBodyConstDLIterC::Next(void) BaseBodyConstDLIterC::operator++(int) BaseBodyConstDLIterC::Prev(void) BaseBodyConstDLIterC::NextCrc(void) BaseBodyConstDLIterC::PrevCrc(void) BaseBodyConstDLIterC::Nth(LongIntT) BaseBodyConstDLIterC::RelNth(LongIntT) BaseBodyConstDLIterC::Index(void) const

BaseBodyConstDLIterC<class DataC>
Double-linked circular list iterator
include	"amma/BBCDLIte.hh"
User Level:	Default
Library:	Mlist
Example:	exBuffer.cc
Section:	Containers.Lists.DList
In Scope:	std

Comments:
The class 'BaseBodyConstDLIterC' is a representation of iterator on a body of a constant double-linked list. Therefore this iterator cannot change the content of the list. Iterator is connected with a list. If the list is empty, the iterator points to the head of the list. The result of positioning of an iterator need not to be a proper element. To avoid pointing to the head of the list the head skipping moving operators NextCrc() and/or PrevCrc() must be used.

private BaseConstDLIterC

BaseBodyDLIterC
BodyConstDLIterC
ConstDLIterC

const DataC & Data() const

Access to the constant object contained in the list element.

const DataC & operator*() const

Access to the constant object contained in the list element.

const DataC * operator->() const

Access to the constant object contained in the list element.

const DataC & NextData() const

Access to the constant object contained in the list element.

const DataC & PrevData() const

Access to the constant object contained in the list element.

const DataC & NextCrcData() const

Access to the constant object contained in the list element.

const DataC & PrevCrcData() const

Access to the constant object contained in the list element.

const DataC & NextData(int offset) const

Access to the constant object contained in the list element.

const DataC & PrevData(int offset) const

Access to the constant object contained in the list element.

const DataC & NextCrcData(int offset) const

Access to the constant object contained in the list element.

const DataC & PrevCrcData(int offset) const

Access to the constant object contained in the list element.

const BodyDListC<DataC> & List() const

Returns the list whose element is pointed to by this iterator. ------------ Predicates -------------------------------------

BooleanT operator==(const BaseBodyConstDLIterC<DataC> & it) const

Returns TRUE if both iterators point to the same list element.

BooleanT operator!=(const BaseBodyConstDLIterC<DataC> & it) const

Returns TRUE if this iterators points to a different list element than the iterator 'it'.

BooleanT IsFirst() const

Returns TRUE if the pointed element is the first in a list.

BooleanT IsLast() const

Returns TRUE if the pointed element is the last one in a list.

BooleanT IsElm() const

Returns TRUE if the pointed an proper element (not a head) of a list. ----------- Positioning the iterator -----------------------------

BaseBodyConstDLIterC<DataC> & First()

Sets the iterator to point to the first element of the list.

BaseBodyConstDLIterC<DataC> & Last()

Sets the iterator to point to the last element of the list.

BaseBodyConstDLIterC<DataC> & Next()

Moves the iterator to the successor of the element.

void operator++(int)

Moves the iterator to the successor of the element.

BaseBodyConstDLIterC<DataC> & Prev()

Moves the iterator to the predecessor of the element.

BaseBodyConstDLIterC<DataC> & NextCrc()

Moves the iterator to the successor of the element. If the result element is not a proper element of the list the iterator is moved to the first element.

BaseBodyConstDLIterC<DataC> & PrevCrc()

Moves the iterator to the predecessor of the element. If the result element is not a proper element of the list the iterator is moved to the last element.

BaseBodyConstDLIterC<DataC> & Nth(LongIntT n)

Sets to the n-th element of the list. The index 'n' can be negative. The first element of the list has the index 0, the last element has the index -1. It does not skip the head of the list.

BaseBodyConstDLIterC<DataC> & RelNth(LongIntT n)

Moves to the n-th element from the current element. The index 'n' can be positive, zero, or negative. Particularly, the n = 0 means no move, n = 1 means the move to the next element, and n = -1 means the move to the previous element.

LongIntT Index() const

Returns the offset of an element from the first element. Particularly, it returns 0 if the iterator points to the first element, it returns -1 if element is the head of the list, and it returns -2 if the element is not contained in the list. The function does not check counter overflow.