|
User Documentation |
|
Centre for Vision, Speech & Signal Processing |
| ConstDLIterC<class DataC>
|
| |
| The class 'ConstDLIterC' is a representation of iterator on a constant double-linked list.
|
| |
| include | "amma/CDLIter.hh" |
| User Level: | Default |
| Library: | Mlist |
| Example: | exDList.cc |
| Section: | Containers.Lists |
| In Scope: | std |
Comments:
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.
Parent Classes:
Methods:
- ConstDLIterC(const DListC<DataC> & list)
-
Creates an iterator operating on the constant 'list'.
The iterator
will point to the first element if there is any, otherwise
to the head of the list.
- ConstDLIterC(const ConstDLIterC<DataC> & iter)
-
Copy constructor.
- ConstDLIterC(const DLIterC<DataC> & iter)
-
Copy constructor.
- ConstDLIterC<DataC> Copy() const
-
Copy constructor.
- const ConstDLIterC<DataC> & operator=(const ConstDLIterC<DataC> & it)
-
Assingment.
This iterator will point to the same list element as
the iterator 'it'.
- const ConstDLIterC<DataC> & DLIter() const
-
- ~ConstDLIterC()
-
Destructor.
- const DListC<DataC> List() const
-
Returns the list whose element is pointed to by this iterator.
- ostream & operator<<(ostream & s,const ConstDLIterC<DataC> & elm)
-
- operator bool() const
-
Is iterator at a valid element ?
This is here to keep the SGI compiler happy.
- 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.
|
Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001
|