Doubly linked non-constant list iterator The List class above only provides for the list framework. More...

#include <List.h>

Public Member Functions
	ListIter (List< t > *st, Bool OWN=False)
	This constructor allows one to construct a ListIter and attach it to the List parameter. More...

	ListIter (List< t > &st)
	This constructor allows one to construct a ListIter and attach it to the List parameter. More...

	ListIter (const ListIter< t > &other)
	These constructors allow for the creation of a ListIter from another ListIter. More...

	ListIter (const ListIter< t > *other)

	ListIter ()
	This is the default constructor. More...

void	addRight (t e)
	This function adds the element to the right of the current cursor position. More...

void	removeRight ()
	This function removes the element to the right of the current cursor position. More...

virtual void	swapRight (ListIter< t > &)
	This function swaps the list section after the current position of the list with the right section of the list of another iterator. More...

t &	getRight ()
	Returns the element to the right of the cursor. More...

const t &	getRight () const

virtual ListIter< t > &	assign (List< t > *other, Bool OWN=False)
	This function changes the List which this ListIter tracks and specifies that the List should be deleted when this iterator is deleted. More...

virtual ListIter< t > &	operator= (List< t > &other)
	This assignment operator changes the List which this iterator tracks to the List parameter. More...

virtual ListIter< t > &	operator= (List< t > *other)

virtual ListIter< t > &	operator= (const ListIter< t > &other)
	These assignment operators allow one to change the List to which this iterator tracks to the List currently associated with the argument ListIter. More...

virtual ListIter< t > &	operator= (const ListIter< t > *other)

	~ListIter ()

Public Member Functions inherited from casacore::ConstListIter< t >
	ConstListIter (const List< t > *st)
	This constructor creates a "ConstListIter" which tracks the "List<t>" parameter. More...

	ConstListIter (const List< t > &st)

	ConstListIter (const ConstListIter< t > &other)
	This constructor creates a "ConstListIter" which tracks the same list tracked by the "ConstListIter<t>" parameter. More...

	ConstListIter (const ConstListIter< t > *other)

	ConstListIter ()
	This is the default constructor. More...

	~ConstListIter ()

void	notify (const Notice &)
	Hook through which `NoticeTarget`s are notified (by `NoticeSource`s). More...

Bool	atStart () const
	This functions allows one to checked if the cursor is at an extreme list position. More...

Bool	atEnd () const

void	operator++ ()
	This function is used to step the cursor forward through the list. More...

void	operator++ (int)

void	operator-- ()
	This function allow for stepping the cursor toward the front of the list. More...

void	operator-- (int)

virtual uInt	pos (uInt)
	"pos()" without arguments returns the current postion of the cursor. More...

uInt	pos () const

uInt	len () const
	This function returns the number of elements in the list. More...

uInt	step (Int offset)
	"step()" with no parameters advances the cursor forward one element. More...

uInt	step ()

const t &	getRight () const
	Returns the element to the right of the cursor. More...

void	toStart ()
	This function moves the cursor to the beginning of the list. More...

void	toEnd ()
	This function moves the cursor to the end of the list. More...

const List< t > *	container () const
	Get the container over which we are iterating, could be null... More...

Public Member Functions inherited from casacore::NoticeTarget
virtual	~NoticeTarget ()
	Destructs this `NoticeTarget`. More...

Bool	isValid () const
	Returns a boolean value telling whether this `NoticeTarget` is still "valid". More...

Bool	isAttached () const
	Returns a boolean value telling whether this `NoticeTarget` is still attached to a `NoticeSource` or not. More...

void	invalidate ()
	Makes the current `NoticeTarget` "invalid". More...

Protected Member Functions
virtual Link< t > *	newLink (t &e, Link< t > p=0, Link< t > n=0)

Protected Member Functions inherited from casacore::NoticeTarget
	NoticeTarget ()
	Creates an unlinked, "invalid" `NoticeTarget`. More...

	NoticeTarget (NoticeSource *v)
	Creates a "valid" `NoticeTarget` linked to the specified `NoticeSource`. More...

	NoticeTarget (NoticeSource &v)

	NoticeTarget (NoticeTarget &other)
	Creates a "valid" `NoticeTarget` linked to the same `NoticeSource` as the `other NoticeTarget`. More...

	NoticeTarget (NoticeTarget *other)

void	unlink ()
	Unlinks this `NoticeTarget` from its `NoticeSource`. More...

void	link (const NoticeTarget &other)
	Links this `NoticeTarget` to the same `NoticeSource` as the `other NoticeTarget`. More...

void	link (const NoticeTarget *other)

Link< NoticeTarget * > *	next ()
	Retrieves the next `NoticeTarget` in the target list of the associated `NoticeSource`. More...

const Link< NoticeTarget * > *	next () const

void	attach (NoticeSource *v)
	Adds this `NoticeTarget` to the target list in the specified `NoticeSource`, so that it will receive all notices sent out by that `NoticeSource`. More...

void	attach (NoticeSource &v)

Protected Attributes
Bool	own
	Indicates if this iterator "owns" the container it observes. More...

Protected Attributes inherited from casacore::ConstListIter< t >
Link< t > *	cur
	enum outside class because of compiler errors on HPUX enum {ConstListIterVersion = 1}; More...

Link< t > *	prev

uInt	curPos

List< t > *	container_

Protected Attributes inherited from casacore::NoticeTarget
Link< NoticeTarget * > *	ilink

NoticeSource *	container

Bool	valid

Private Member Functions
ConstListIter< t > &	operator= (const List< t > &)
	This assignment operator substitutes the "List<t>" tracked by this iterator to the "List<t>" passed as an argument. More...

ConstListIter< t > &	operator= (const List< t > *)

ConstListIter< t > &	operator= (const ConstListIter< t > &)
	This assignment operator substitutes the "List<t>" tracked by this iterator to the "List<t>" tracked by the passed "ConstListIter<t>" argument. More...

ConstListIter< t > &	operator= (const ConstListIter< t > *)

Detailed Description

template<class t>
class casacore::ListIter< t >

Doubly linked non-constant list iterator The List class above only provides for the list framework.

This is one of two classes which allow list iteration, insertion, and removal. This class can be used to modify a list. Unlike ConstListIter, this class can insert and remove elements from a list as well as look at or observe a list. ConstListIter should be used whenever the list is not modified.

All of the operations take place to the right of a conceptual cursor. The cursor starts out before the first element of the list and can be incremented past the last element of the list. Going further than the end of the list results in an exception. All additions and deletions occur to the right of this conceptual cursor. In addition, this class uses the Notice class to ensure that multiple iterators which are observing the same list are updated as the list changes. This is important when multiple iterators are used.

Example

#include <casacore/casa/Containers/List.h>
#include <casacore/casa/Containers/ListIO.h>
 
main() {
// The conceptual cursors are:
//   |  for one
//   ^  for two
//   _  for three
ListIter<int> one(new List<int>,True);
ListIter<int> three, two = one;
one.addRight(12);                       //  |^ 12
one.addRight(2);                        //  |^ 2 12
one.addRight(89);                       //  |^ 89 2 12
cout << one.getRight() << " " 
<< two.getRight() << endl;
two.addRight(21);                       //  |^ 21 89 2 12
cout << one.getRight() << " " 
<< two.getRight() << endl;
one++; two++; two++;                    //   21 | 89 ^ 2 12
three = one;                            //   21 |_ 89 ^ 2 12
one.removeRight();                      //   21 |^_ 2 12
cout << one.getRight() << " " 
<< two.getRight() << " "
<< three.getRight() << endl;
three.addRight(17);                     //   21 |^_ 17 2 12
 
cout << one.getRight() << " " 
<< two.getRight() << " "
<< three.getRight() << endl;
 
one.toEnd();                            //   21 ^_ 17 2 12 |
one.addRight(18);                       //   21 ^_ 17 2 12 | 18
two.pos(3);                             //   21 _ 17 2 ^ 12 | 18
three--;                                //   _ 21 17 2 ^ 12 | 18
two.step();                             //   _ 21 17 2 12 ^| 18
one.step(4);                            //   _ 21 17 | 2 12 ^ 18
cout << "one:   " << one << endl;
cout << "two:   " << two << endl;
cout << "three: " << three << endl;
 
return 0;
}

The output from this example would look like:

 89 89
 21 21
 2 2 2
 17 2 17
 one:   len=5 pos=2 21 17 2 12 18
 two:   len=5 pos=4 21 17 2 12 18
 three: len=5 pos=0 21 17 2 12 18

Tip: This class uses the "Notice" classes to implement "dynamic" cursors so that multiple cursors are updated as elements are added and removed from the list;

Definition at line 607 of file List.h.

Constructor & Destructor Documentation

◆ ListIter() [1/5]

template<class t >

casacore::ListIter< t >::ListIter	(	List< t > *	st,
		Bool	OWN = `False`
	)

inline

This constructor allows one to construct a ListIter and attach it to the List parameter.

The own flag can be set to indicate that the List should be destroyed when the ListIter is deleted.

Definition at line 616 of file List.h.

◆ ListIter() [2/5]

template<class t >

casacore::ListIter< t >::ListIter ( List< t > & st )

This constructor allows one to construct a ListIter and attach it to the List parameter.

◆ ListIter() [3/5]

template<class t >

casacore::ListIter< t >::ListIter ( const ListIter< t > & other )

These constructors allow for the creation of a ListIter from another ListIter.

This will attach this ListIter to the List tracked by the ListIter parameter at the time of construction.

◆ ListIter() [4/5]

template<class t >

casacore::ListIter< t >::ListIter ( const ListIter< t > * other )

inline

Definition at line 632 of file List.h.

◆ ListIter() [5/5]

template<class t >

casacore::ListIter< t >::ListIter ( )

inline

This is the default constructor.

It allows one to create an initially invalid empty ListIter. The instantiated class will accept assignment and thus become valid later.

Definition at line 640 of file List.h.

◆ ~ListIter()

template<class t >

casacore::ListIter< t >::~ListIter ( )

Member Function Documentation

◆ addRight()

template<class t >

void casacore::ListIter< t >::addRight ( t e )

inline

This function adds the element to the right of the current cursor position.

Allow container to update

Definition at line 647 of file List.h.

References AlwaysAssert, casacore::C::c, casacore::ConstListIter< t >::container_, casacore::ConstListIter< t >::cur, casacore::ConstListIter< t >::curPos, casacore::NoticeTarget::isValid(), casacore::ListIter< t >::newLink(), casacore::ConstListIter< t >::notify(), and casacore::ConstListIter< t >::prev.

◆ assign()

template<class t >

virtual ListIter<t>& casacore::ListIter< t >::assign	(	List< t > *	other,
		Bool	OWN = `False`
	)

virtual

This function changes the List which this ListIter tracks and specifies that the List should be deleted when this iterator is deleted.

◆ getRight() [1/2]

template<class t >

t& casacore::ListIter< t >::getRight ( )

inline

Returns the element to the right of the cursor.

Definition at line 679 of file List.h.

References AlwaysAssert, casacore::ConstListIter< t >::cur, casacore::NoticeTarget::isValid(), and casacore::throw_list_end_error().

◆ getRight() [2/2]

template<class t >

const t& casacore::ListIter< t >::getRight ( ) const

inline

Definition at line 684 of file List.h.

◆ newLink()

template<class t >

virtual Link<t>* casacore::ListIter< t >::newLink	(	t &	e,
		Link< t > *	p = `0`,
		Link< t > *	n = `0`
	)

protectedvirtual

Referenced by casacore::ListIter< t >::addRight().

◆ operator=() [1/8]

template<class t >

ConstListIter<t>& casacore::ListIter< t >::operator= ( const ConstListIter< t > & other )

privatevirtual

This assignment operator substitutes the "List<t>" tracked by this iterator to the "List<t>" tracked by the passed "ConstListIter<t>" argument.

Reimplemented from casacore::ConstListIter< t >.

◆ operator=() [2/8]

template<class t >

ConstListIter<t>& casacore::ListIter< t >::operator= ( const ConstListIter< t > * )

privatevirtual

Reimplemented from casacore::ConstListIter< t >.

◆ operator=() [3/8]

template<class t >

ConstListIter<t>& casacore::ListIter< t >::operator= ( const List< t > & other )

privatevirtual

This assignment operator substitutes the "List<t>" tracked by this iterator to the "List<t>" passed as an argument.

Reimplemented from casacore::ConstListIter< t >.

◆ operator=() [4/8]

template<class t >

ConstListIter<t>& casacore::ListIter< t >::operator= ( const List< t > * )

privatevirtual

Reimplemented from casacore::ConstListIter< t >.

◆ operator=() [5/8]

template<class t >

virtual ListIter<t>& casacore::ListIter< t >::operator= ( const ListIter< t > & other )

virtual

These assignment operators allow one to change the List to which this iterator tracks to the List currently associated with the argument ListIter.

◆ operator=() [6/8]

template<class t >

virtual ListIter<t>& casacore::ListIter< t >::operator= ( const ListIter< t > * other )

virtual

◆ operator=() [7/8]

template<class t >

virtual ListIter<t>& casacore::ListIter< t >::operator= ( List< t > & other )

virtual

This assignment operator changes the List which this iterator tracks to the List parameter.

◆ operator=() [8/8]

template<class t >

virtual ListIter<t>& casacore::ListIter< t >::operator= ( List< t > * other )

virtual

◆ removeRight()

template<class t >

void casacore::ListIter< t >::removeRight ( )

This function removes the element to the right of the current cursor position.

◆ swapRight()

template<class t >

virtual void casacore::ListIter< t >::swapRight ( ListIter< t > & )

virtual

This function swaps the list section after the current position of the list with the right section of the list of another iterator.

This can be particularly useful for "remembering" the position of a cursor in a list.

Member Data Documentation

◆ own

template<class t >

Bool casacore::ListIter< t >::own

protected

Indicates if this iterator "owns" the container it observes.

Definition at line 727 of file List.h.

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

casa/Containers/List.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<class t> class casacore::ListIter< t >

Example

Constructor & Destructor Documentation

◆ ListIter() [1/5]

◆ ListIter() [2/5]

◆ ListIter() [3/5]

◆ ListIter() [4/5]

◆ ListIter() [5/5]

◆ ~ListIter()

Member Function Documentation

◆ addRight()

◆ assign()

◆ getRight() [1/2]

◆ getRight() [2/2]

◆ newLink()

◆ operator=() [1/8]

◆ operator=() [2/8]

◆ operator=() [3/8]

◆ operator=() [4/8]

◆ operator=() [5/8]

◆ operator=() [6/8]

◆ operator=() [7/8]

◆ operator=() [8/8]

◆ removeRight()

◆ swapRight()

Member Data Documentation

◆ own

template<class t>
class casacore::ListIter< t >