OFList< T > Class Template Reference

double linked list template class. More...

Inheritance diagram for OFList< T >:

List of all members.

Public Member Functions
OFIterator< T >	insert (OFIterator< T > position, const T &x)
	inserts an element into the list before the given position.
	OFList ()
	default constructor
	OFList (const OFList< T > &oldList)
	copy constructor
OFIterator< T >	begin () const
	returns an iterator referencing the first element in the list.
OFIterator< T >	end () const
	returns an iterator which points to the past-to-end element of the list.
OFBool	empty () const
	returns true if list is empty.
size_t	size () const
	returns number of elements in the list.
T &	front ()
	returns a reference to the first element in the list.
const T &	front () const
	returns a constant reference to the first element in the list.
T &	back ()
	returns a reference to the last element in the list.
const T &	back () const
	returns a constant reference to the last element in the list.
void	push_front (const T &x)
	inserts before the first element of the list.
void	pop_front ()
	removes the first element of the list.
void	push_back (const T &x)
	inserts after the last element of the list.
void	pop_back ()
	removes the last element of the list.
void	insert (OFIterator< T > position, size_t n, const T &x)
	inserts n elements with value x into the list, before the given position.
OFIterator< T >	erase (OFIterator< T > position)
	removes the element at the given position from the list.
OFIterator< T >	erase (OFIterator< T > position, OFIterator< T > last)
	removes all elements in the range [position,last) from the list.
void	clear ()
	removes all elements from the list.
void	splice (OFIterator< T > position, OFList< T > &x)
	moves the contents of list x into the current list before the given position.
void	splice (OFIterator< T > position, OFList< T > &x, OFIterator< T > i)
	inserts one element from list x into the current list and removes it from x
void	splice (OFIterator< T > position, OFList< T > &x, OFIterator< T > first, OFIterator< T > last)
	inserts elements in the range [first, last) before position and removes the elements from x
void	remove (const T &value)
	removes all elements from the list referred by an iterator i where *i == value
OFList< T > &	operator= (const OFList< T > &arg)
	copy assignment operator
Private Member Functions
void	copy (const OFList< T > &oldList)
	inserts a copy of the given list into the current list.
void	recalcListSize ()
	counts the elements in the list and adjusts the listSize member variable.

---

Detailed Description

template<class T>
class OFList< T >

double linked list template class.

The interface is a subset of the STL list class.

---

Member Function Documentation

template<class T>

T& OFList< T >::back

(

)

[inline]

returns a reference to the last element in the list.

May only be called if list is non-empty.

Returns:

last element in list, by reference

template<class T>

const T& OFList< T >::back

(

)

const [inline]

returns a constant reference to the last element in the list.

May only be called if list is non-empty.

Returns:

last element in list, by constant reference

template<class T>

OFIterator<T> OFList< T >::begin

(

)

const [inline]

returns an iterator referencing the first element in the list.

If the list is empty, then begin() == end().

Returns:

iterator to first element of list, by value.

template<class T>

void OFList< T >::clear

(

)

[inline]

removes all elements from the list.

All iterators pointing to elements in the list become invalid.

template<class T>

void OFList< T >::copy

(

const OFList< T > &

oldList

)

[inline, private]

inserts a copy of the given list into the current list.

Parameters:

oldList

list to be copied

template<class T>

OFBool OFList< T >::empty

(

)

const [inline]

returns true if list is empty.

Returns:

OFTrue if list is empty, OFFalse otherwise.

template<class T>

OFIterator<T> OFList< T >::end

(

)

const [inline]

returns an iterator which points to the past-to-end element of the list.

Returns:

iterator to past-to-end, by value.

template<class T>

OFIterator<T> OFList< T >::erase

(

OFIterator< T >

position

)

[inline]

removes the element at the given position from the list.

All iterators pointing to the removed element become invalid.

Returns:

iterator pointing to the element after the removed one

template<class T>

OFIterator<T> OFList< T >::erase	(	OFIterator< T >	position,
		OFIterator< T >	last
	)		[inline]

removes all elements in the range [position,last) from the list.

All iterators pointing to the removed elements become invalid.

Parameters:

position	iterator to the first element to be deleted
last	iterator pointing to the element after the last element to be removed

Returns:

iterator pointing to the element after the last removed element

template<class T>

T& OFList< T >::front

(

)

[inline]

returns a reference to the first element in the list.

May only be called if list is non-empty.

Returns:

first element in list, by reference

template<class T>

const T& OFList< T >::front

(

)

const [inline]

returns a constant reference to the first element in the list.

May only be called if list is non-empty.

Returns:

first element in list, by constant reference

template<class T>

OFIterator<T> OFList< T >::insert	(	OFIterator< T >	position,
		const T &	x
	)		[inline]

inserts an element into the list before the given position.

Parameters:

position	iterator to position before which the element is inserted
x	value from which the new list entry is copy-constructed

Returns:

iterator pointing to the new element in the list

template<class T>

void OFList< T >::insert	(	OFIterator< T >	position,
		size_t	n,
		const T &	x
	)		[inline]

inserts n elements with value x into the list, before the given position.

Parameters:

position	iterator to position before which the elements are inserted
n	number of entries to be created
x	value from which the new list entries are copy-constructed

template<class T>

OFList<T>& OFList< T >::operator=

(

const OFList< T > &

arg

)

[inline]

copy assignment operator

Parameters:

arg	the list to copy from

Returns:

*this

template<class T>

void OFList< T >::pop_back

(

)

[inline]

removes the last element of the list.

May only be called if list is non-empty. All iterators pointing to the removed element become invalid.

template<class T>

void OFList< T >::pop_front

(

)

[inline]

removes the first element of the list.

May only be called if list is non-empty. All iterators pointing to the removed element become invalid.

template<class T>

void OFList< T >::push_back

(

const T &

x

)

[inline]

inserts after the last element of the list.

Parameters:

x	value from which the new list entry is copy constructed

template<class T>

void OFList< T >::push_front

(

const T &

x

)

[inline]

inserts before the first element of the list.

Parameters:

x	value from which the new list entry is copy constructed

template<class T>

void OFList< T >::remove

(

const T &

value

)

[inline]

removes all elements from the list referred by an iterator i where *i == value

Parameters:

value

value to be compared with list contents

template<class T>

size_t OFList< T >::size

(

)

const [inline]

returns number of elements in the list.

Returns:

number of elements

template<class T>

void OFList< T >::splice	(	OFIterator< T >	position,
		OFList< T > &	x
	)		[inline]

moves the contents of list x into the current list before the given position.

Parameters:

position	iterator to position before which the elements are inserted
x	list from which the elements are taken, becomes empty

template<class T>

void OFList< T >::splice	(	OFIterator< T >	position,
		OFList< T > &	x,
		OFIterator< T >	i
	)		[inline]

inserts one element from list x into the current list and removes it from x

Parameters:

position	iterator to position before which the element is inserted
x	list from which the element is taken
i	iterator to element in list x which is to be moved

template<class T>

void OFList< T >::splice	(	OFIterator< T >	position,
		OFList< T > &	x,
		OFIterator< T >	first,
		OFIterator< T >	last
	)		[inline]

inserts elements in the range [first, last) before position and removes the elements from x

Parameters:

position	iterator to position before which the elements are inserted
x	list from which the elements are taken
first	iterator to first element in list x to be moved
last	iterator to element after last element in list x to be moved

---

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

• ofstd/include/dcmtk/ofstd/oflist.h