List< Value > Class Template Reference
[Miscellaneous]

Extended list object. More...

#include <list.h>

List of all members.

Public Types
Type Definitions
typedef std::list< Value >::iterator	Iterator
	Iterator type.
typedef std::list< Value >::iterator	iterator
typedef std::list< Value >::const_iterator	ConstIterator
	Constant iterator type.
typedef std::list< Value >::const_iterator	const_iterator
Public Member Functions
bool	operator== (const List< Value > &list) const throw ()
	Equality operator.
bool	operator!= (const List< Value > &list) const throw ()
	Inequality operator.
Constructors and Destructors
	List () throw ()
	Default constructor.
	List (const List &new_list, bool) throw ()
	Copy constructor.
void	destroy () throw ()
	Clear the list.
virtual	~List () throw ()
	Destructor.
Assignment
void	set (const List &list, bool=true) throw ()
	Assign a list from another.
const List &	operator= (const List &list) throw ()
	Assign a list from another.
void	get (List &list, bool deep=true) const throw ()
	Assign the content of a list to another.
void	swap (List &list) throw ()
	Swaps the contents of two lists.
Accessors
Size	getSize () const throw ()
	Return the size of the list.
bool	remove (const Value &item) throw ()
	Remove an item from the list.
Predicates
bool	isEmpty () const throw ()
	Return true if the list is empty.
DatatypeMiscellaneous
virtual void	host (Visitor< List< Value > > &visitor) throw ()
	Visitor host method.
Internal Iterators
bool	apply (UnaryProcessor< Value > &processor) throw ()
	Processor application method.

---

Detailed Description

template<typename Value>
class List< Value >

Extended list object.

This object is an improved version of the STL list class

---

Member Typedef Documentation

template<typename Value> typedef std::list<Value>::const_iterator List< Value >::ConstIterator

Constant iterator type. Reimplemented in PeakList< PT >, PyCompositeList, PyIndexList, and PeakList< Peak< float > >.

template<typename Value> typedef std::list<Value>::iterator List< Value >::Iterator

Iterator type. Reimplemented in PeakList< PT >, PyCompositeList, PyIndexList, and PeakList< Peak< float > >.

---

Constructor & Destructor Documentation

template<typename Value> List< Value >::List (   )  throw ()

Default constructor. Create an empty list.

template<typename Value> List< Value >::List (  const List< Value > &  new_list, bool  )  throw ()

Copy constructor. Create a copy of an existing list. Parameters: map  the list to be copied deep  ignored

---

Member Function Documentation

template<typename Value> bool List< Value >::apply (  UnaryProcessor< Value > &  processor  )  throw ()

Processor application method. Applies the processor to each entry of the list. Parameters: processor  the processor to be applied

template<typename Value> Size List< Value >::getSize (   )  const throw ()

Return the size of the list.

template<typename Value> void List< Value >::host (  Visitor< List< Value > > &  visitor  )  throw () [virtual]

Visitor host method. Lists may be visited. Parameters: visitor  the visitor

template<typename Value> bool List< Value >::isEmpty (   )  const throw ()

Return true if the list is empty. This method return true if the list does not contain any entries.

template<typename Value> bool List< Value >::operator!= (  const List< Value > &  list  )  const throw ()

Inequality operator. Test if two instances differ in at least one element.

template<typename Value> const List& List< Value >::operator= (  const List< Value > &  list  )  throw ()

Assign a list from another.

template<typename Value> bool List< Value >::operator== (  const List< Value > &  list  )  const throw ()

Equality operator. Test if two instances have the same size and same items at the same positions.

template<typename Value> bool List< Value >::remove (  const Value &  item  )  throw ()

Remove an item from the list. The first item that matches item will be removed. Parameters: item  the item to be removed Returns: bool true if the item was removed

template<typename Value> void List< Value >::set (  const List< Value > &  list, bool  = true )  throw ()

Assign a list from another. Parameters: list  the map to be copied deep  ignored