casacore::ListNotice< t > Class Template Reference

Linked list update notice. More...

#include <List.h>

Inheritance diagram for casacore::ListNotice< t >:

Public Types
enum	modification { DELETE, ADD, REMOVE, SWAP }
Public Member Functions
uInt	type () const
	This function returns the Notice "type", which is retrieved from the "type registry".
int	operator== (const Notice &op) const
	This operator can be used to compare two ListNotices.
Private Member Functions
	ListNotice (modification m, Link< t > oc, Link< t > op, Link< t > nc, Link< t > np, int of, int nf=0)
	This is used to construct a list notice.
	ListNotice ()
	This constructor is used to initialize a notice for a deleted "List".
Private Attributes
modification	mod
Link< t > *	oprev
Link< t > *	ocur
Link< t > *	nprev
Link< t > *	ncur
int	off
int	otherOff
Friends
class	ConstListIter< t >
class	ListIter< t >
class	List< t >

Detailed Description

template<class t>
class casacore::ListNotice< t >

Linked list update notice.

Intended use:

Internal

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Synopsis

This class is the notification which is passed between List<t> and ListIter<t> in order to keep cursors and container in sync. This is the mechanism which allows multiple iterators to view the same list and automatically update as the list is changed. See the Notice class for more information.

Definition at line 70 of file List.h.

Member Enumeration Documentation

template<class t>

enum casacore::ListNotice::modification

Enumerator:

DELETE
ADD
REMOVE
SWAP

Definition at line 75 of file List.h.

Constructor & Destructor Documentation

template<class t>

casacore::ListNotice< t >::ListNotice	(	modification	m,
		Link< t > *	oc,
		Link< t > *	op,
		Link< t > *	nc,
		Link< t > *	np,
		int	of,
		int	nf = `0`
	)			`[inline, private]`

This is used to construct a list notice.

The parameters are:

(m) what was done to the list
(oc) the old current position
(op) the old previous position
(nc) the new current position
(np) the new previous position
(of) current offset;
(nf) other offset (only used with SWAP mod)

Definition at line 112 of file List.h.

template<class t>

casacore::ListNotice< t >::ListNotice ( ) [inline, private]

This constructor is used to initialize a notice for a deleted "List".

Definition at line 119 of file List.h.

Member Function Documentation

template<class t>

int casacore::ListNotice< t >::operator== ( const Notice & op ) const

This operator can be used to compare two ListNotices.

template<class t>

uInt casacore::ListNotice< t >::type ( ) const [virtual]

This function returns the Notice "type", which is retrieved from the "type registry".

The registry information is maintained automatically by the Notice constructors. A form of run time type information, this function is mostly intended for advanced users.

Implements casacore::Notice.