CList类参考

---

详细描述

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.

在文件List.h第78行定义。

继承图，类CList

所有成员的列表。

公有成员
	CList (bool p_delete_data=false)
virtual	~CList ()
int32_t	get_num_elements ()
CSGObject *	get_first_element ()
CSGObject *	get_last_element ()
CSGObject *	get_next_element ()
CSGObject *	get_previous_element ()
CSGObject *	get_current_element ()
bool	append_element (CSGObject *data)
bool	append_element_at_listend (CSGObject *data)
bool	insert_element (CSGObject *data)
CSGObject *	delete_element (void)
virtual void	load_serializable_post () throw (ShogunException)
virtual const char *	get_name (void) const
thread safe list access functions
CSGObject *	get_first_element (CListElement *&p_current)
CSGObject *	get_last_element (CListElement *&p_current)
CSGObject *	get_next_element (CListElement *&p_current)
CSGObject *	get_previous_element (CListElement *&p_current)
CSGObject *	get_current_element (CListElement *&p_current)

---

构造及析构函数文档

CList

(

bool

p_delete_data = false

)

constructor

参数:

p_delete_data

if data shall be deleted

在文件List.h第85行定义。

virtual ~CList

(

)

[virtual]

在文件List.h第102行定义。

---

成员函数文档

bool append_element

(

CSGObject *

data

)

append element AFTER the current element

参数:

data	data element to append

返回:

if appending was successful

在文件List.h第307行定义。

bool append_element_at_listend

(

CSGObject *

data

)

append at end of list

参数:

data	data element to append

返回:

if appending was successful

在文件List.h第350行定义。

CSGObject* delete_element

(

void

)

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

返回:

the elements data - if available - otherwise NULL

在文件List.h第413行定义。

CSGObject* get_current_element

(

CListElement *&

p_current

)

get current element in list

参数:

p_current

current list element

返回:

current element in list or NULL if not available

在文件List.h第289行定义。

CSGObject* get_current_element

(

)

get current element in list

返回:

current element in list or NULL if not available

在文件List.h第196行定义。

CSGObject* get_first_element

(

)

go to first element in list and return it

返回:

first element in list or NULL if list is empty

在文件List.h第128行定义。

CSGObject* get_first_element

(

CListElement *&

p_current

)

go to first element in list and return it

参数:

p_current

current list element

返回:

first element in list or NULL if list is empty

在文件List.h第217行定义。

CSGObject* get_last_element

(

CListElement *&

p_current

)

go to last element in list and return it

参数:

p_current

current list element

返回:

last element in list or NULL if list is empty

在文件List.h第235行定义。

CSGObject* get_last_element

(

)

go to last element in list and return it

返回:

last element in list or NULL if list is empty

在文件List.h第145行定义。

virtual const char* get_name

(

void

)

const [virtual]

返回:

object name

实现了CSGObject。

在文件List.h第467行定义。

CSGObject* get_next_element

(

CListElement *&

p_current

)

go to next element in list and return it

参数:

p_current

current list element

返回:

next element in list or NULL if list is empty

在文件List.h第253行定义。

CSGObject* get_next_element

(

)

go to next element in list and return it

返回:

next element in list or NULL if list is empty

在文件List.h第162行定义。

int32_t get_num_elements

(

void

)

get number of elements in list

返回:

number of elements in list

在文件List.h第122行定义。

CSGObject* get_previous_element

(

)

go to previous element in list and return it

返回:

previous element in list or NULL if list is empty

在文件List.h第179行定义。

CSGObject* get_previous_element

(

CListElement *&

p_current

)

go to previous element in list and return it

参数:

p_current

current list element

返回:

previous element in list or NULL if list is empty

在文件List.h第271行定义。

bool insert_element

(

CSGObject *

data

)

insert element BEFORE the current element

参数:

data	data element to insert

返回:

if inserting was successful

在文件List.h第364行定义。

virtual void load_serializable_post

(

void

)

throw (ShogunException) [virtual]

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

异常:

ShogunException

Will be thrown if an error occurres.

重载CSGObject。

在文件List.h第452行定义。

---

该类的文档由以下文件生成：

• List.h