CList< T > Class Template Reference


Detailed Description

template<class T>
class CList< T >

Class List implements a doubly connected list for low-level-objects.

For higher level objects pointers should be used. The list supports calling delete() of an object that is to be removed from the list.

Definition at line 52 of file List.h.

Inheritance diagram for CList< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CList (bool p_delete_data=false)
virtual ~CList ()
int32_t get_num_elements ()
get_first_element ()
get_last_element ()
get_next_element ()
get_previous_element ()
get_current_element ()
bool append_element (T data)
bool insert_element (T data)
delete_element (void)
virtual const char * get_name () const
thread safe list access functions



get_first_element (CListElement< T > *&p_current)
get_last_element (CListElement< T > *&p_current)
get_next_element (CListElement< T > *&p_current)
get_previous_element (CListElement< T > *&p_current)
get_current_element (CListElement< T > *&p_current)

Constructor & Destructor Documentation

template<class T>
CList< T >::CList ( bool  p_delete_data = false  ) 

constructor

Parameters:
p_delete_data if data shall be deleted

Definition at line 59 of file List.h.

template<class T>
virtual CList< T >::~CList (  )  [virtual]

Definition at line 69 of file List.h.


Member Function Documentation

template<class T>
bool CList< T >::append_element ( data  ) 

append element AFTER the current element

Parameters:
data data element to append
Returns:
if appending was successful

Definition at line 269 of file List.h.

template<class T>
T CList< T >::delete_element ( void   ) 

erases current element the new current element is the successor of the former current element

Returns:
the elements data - if available - is returned else NULL

Definition at line 361 of file List.h.

template<class T>
T CList< T >::get_current_element ( CListElement< T > *&  p_current  ) 

get current element in list

Parameters:
p_current current list element
Returns:
current element in list or NULL if not available

Definition at line 251 of file List.h.

template<class T>
T CList< T >::get_current_element (  ) 

get current element in list

Returns:
current element in list or NULL if not available

Definition at line 158 of file List.h.

template<class T>
T CList< T >::get_first_element ( CListElement< T > *&  p_current  ) 

go to first element in list and return it

Parameters:
p_current current list element
Returns:
first element in list or NULL if list is empty

Definition at line 179 of file List.h.

template<class T>
T CList< T >::get_first_element (  ) 

go to first element in list and return it

Returns:
first element in list or NULL if list is empty

Definition at line 90 of file List.h.

template<class T>
T CList< T >::get_last_element ( CListElement< T > *&  p_current  ) 

go to last element in list and return it

Parameters:
p_current current list element
Returns:
last element in list or NULL if list is empty

Definition at line 197 of file List.h.

template<class T>
T CList< T >::get_last_element (  ) 

go to last element in list and return it

Returns:
last element in list or NULL if list is empty

Definition at line 107 of file List.h.

template<class T>
virtual const char* CList< T >::get_name (  )  const [virtual]
Returns:
object name

Implements CSGObject.

Definition at line 400 of file List.h.

template<class T>
T CList< T >::get_next_element ( CListElement< T > *&  p_current  ) 

go to next element in list and return it

Parameters:
p_current current list element
Returns:
next element in list or NULL if list is empty

Definition at line 215 of file List.h.

template<class T>
T CList< T >::get_next_element (  ) 

go to next element in list and return it

Returns:
next element in list or NULL if list is empty

Definition at line 124 of file List.h.

template<class T>
int32_t CList< T >::get_num_elements (  ) 

get number of elements in list

Returns:
number of elements in list

Definition at line 84 of file List.h.

template<class T>
T CList< T >::get_previous_element ( CListElement< T > *&  p_current  ) 

go to previous element in list and return it

Parameters:
p_current current list element
Returns:
previous element in list or NULL if list is empty

Definition at line 233 of file List.h.

template<class T>
T CList< T >::get_previous_element (  ) 

go to previous element in list and return it

Returns:
previous element in list or NULL if list is empty

Definition at line 141 of file List.h.

template<class T>
bool CList< T >::insert_element ( data  ) 

insert element BEFORE the current element

Parameters:
data data element to insert
Returns:
if inserting was successful

Definition at line 312 of file List.h.


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

SHOGUN Machine Learning Toolbox - Documentation