XnList Class Reference

#include <XnList.h>

List of all members.

Classes
class	ConstIterator
class	Iterator
Public Member Functions
XnStatus	AddAfter (ConstIterator where, const XnValue &val)
XnStatus	AddBefore (ConstIterator where, const XnValue &val)
XnStatus	AddFirst (const XnValue &value)
XnStatus	AddLast (const XnValue &value)
Iterator	begin ()
ConstIterator	begin () const
XnStatus	Clear ()
Iterator	end ()
ConstIterator	end () const
Iterator	Find (const XnValue &value)
ConstIterator	Find (const XnValue &value) const
XnBool	IsEmpty () const
Iterator	rbegin ()
ConstIterator	rbegin () const
XnStatus	Remove (ConstIterator where, XnValue &value)
virtual XnStatus	Remove (ConstIterator where)
Iterator	rend ()
ConstIterator	rend () const
XnUInt32	Size () const
	XnList ()
virtual	~XnList ()
Protected Member Functions
XnStatus	Add (XnNode *pWhere, const XnValue &val)
void	Init (INiNodeAllocator *pNodeAllocator)
	XnList (INiNodeAllocator *pNodeAllocator)
Protected Attributes
XnBool	m_bOwnsAllocator
XnNode *	m_pBase
INiNodeAllocator *	m_pNodeAllocator
Friends
class	XnNodeManager

---

Detailed Description

The linked list

Definition at line 44 of file XnList.h.

---

Constructor & Destructor Documentation

XnList::XnList

(

)

[inline]

Constructor. Initialize internal representations

Definition at line 222 of file XnList.h.

virtual XnList::~XnList

(

)

[inline, virtual]

Destructor. Destroy internal representations

Definition at line 232 of file XnList.h.

XnList::XnList

(

INiNodeAllocator *

pNodeAllocator

)

[inline, protected]

Constructor. Initialize internal representations

Definition at line 503 of file XnList.h.

---

Member Function Documentation

XnStatus XnList::Add	(	XnNode *	pWhere,
		const XnValue &	val
	)		[inline, protected]

Add a new value to the list

Parameters:

pWhere	[in] The XnNode after which to add the new value
val	[in] The value to add to the list

Returns:

XN_STATUS_ALLOC_FAILED Failed to add to the list because no nodes are available,

Definition at line 530 of file XnList.h.

XnStatus XnList::AddAfter	(	ConstIterator	where,
		const XnValue &	val
	)		[inline]

Add a new value after the object pointed to by the iterator

Parameters:

where	[in] iterator to the position after which to add the new value
val	[in] The value to add to the list

Returns:

XN_STATUS_ALLOC_FAILED Failed to add to the list because no nodes are available, XN_STATUS_ILLEGAL_POSITION iterator is invalid

Definition at line 279 of file XnList.h.

XnStatus XnList::AddBefore	(	ConstIterator	where,
		const XnValue &	val
	)		[inline]

Add a new value before the object pointed to by the iterator

Parameters:

where	[in] iterator to the position before which to add the new value
val	[in] The value to add to the list

Returns:

XN_STATUS_ALLOC_FAILED Failed to add to the list because no nodes are available,

Definition at line 297 of file XnList.h.

XnStatus XnList::AddFirst

(

const XnValue &

value

)

[inline]

Add a new value at the beginning of list

Parameters:

value

[in] The value to add to the head of the list

Returns:

XN_STATUS_ALLOC_FAILED Failed to add to the list because no nodes are available.

Definition at line 253 of file XnList.h.

XnStatus XnList::AddLast

(

const XnValue &

value

)

[inline]

Add a new value at the end of the list

Parameters:

value

[in] The value to add to the tail of the list

Returns:

XN_STATUS_ALLOC_FAILED Failed to add to the list because no nodes are available.

Definition at line 265 of file XnList.h.

Iterator XnList::begin

(

)

[inline]

An iterator to the first entry of the list (non-const version)

Definition at line 436 of file XnList.h.

ConstIterator XnList::begin

(

)

const [inline]

An iterator to the first entry of the list (const version)

Definition at line 444 of file XnList.h.

XnStatus XnList::Clear

(

)

[inline]

Remove all entries from the list

Definition at line 405 of file XnList.h.

Iterator XnList::end

(

)

[inline]

An iterator 1to the end of the list (non-const version). The position is invalid.

Definition at line 452 of file XnList.h.

ConstIterator XnList::end

(

)

const [inline]

An iterator to the end of the list (const version). The position is invalid.

Definition at line 460 of file XnList.h.

Iterator XnList::Find

(

const XnValue &

value

)

[inline]

Get an iterator pointing to a value in the list.

Parameters:

value

[in] The searched value

Returns:

end() if value doesn't exist

Definition at line 315 of file XnList.h.

ConstIterator XnList::Find

(

const XnValue &

value

)

const [inline]

Get an iterator pointing to a value in the list.

Parameters:

value

[in] The searched value

Returns:

end() if value doesn't exist

Definition at line 339 of file XnList.h.

void XnList::Init

(

INiNodeAllocator *

pNodeAllocator

)

[inline, protected]

Definition at line 509 of file XnList.h.

XnBool XnList::IsEmpty

(

)

const [inline]

Check if list is empty

Definition at line 416 of file XnList.h.

Iterator XnList::rbegin

(

)

[inline]

An iterator to the last entry of the list (non-const version)

Definition at line 468 of file XnList.h.

ConstIterator XnList::rbegin

(

)

const [inline]

An iterator to the last entry of the list (const version)

Definition at line 476 of file XnList.h.

XnStatus XnList::Remove	(	ConstIterator	where,
		XnValue &	value
	)		[inline]

Remove a value from the list

Parameters:

where	[in] Iterator pointing to an entry in the list
value	[out] The value that was in the removed entry

Returns:

XN_STATUS_ILLEGAL_POSITION iterator was invalid

Definition at line 364 of file XnList.h.

virtual XnStatus XnList::Remove

(

ConstIterator

where

)

[inline, virtual]

Remove a value from the list

Parameters:

where

[in] Iterator pointing to an entry in the list

Returns:

XN_STATUS_ILLEGAL_POSITION iterator was invalid

Definition at line 377 of file XnList.h.

Iterator XnList::rend

(

)

[inline]

An iterator to the beginning of the list (non-const version). This position is invalid

Definition at line 484 of file XnList.h.

ConstIterator XnList::rend

(

)

const [inline]

An iterator to the beginning of the list (const version). This position is invalid

Definition at line 492 of file XnList.h.

XnUInt32 XnList::Size

(

)

const [inline]

Current size of the list

Definition at line 424 of file XnList.h.

---

Friends And Related Function Documentation

friend class XnNodeManager [friend]

Definition at line 498 of file XnList.h.

---

Member Data Documentation

XnBool XnList::m_bOwnsAllocator [protected]

Definition at line 553 of file XnList.h.

XnNode* XnList::m_pBase [protected]

The base node for the list

Definition at line 550 of file XnList.h.

INiNodeAllocator* XnList::m_pNodeAllocator [protected]

Definition at line 552 of file XnList.h.

---

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

• XnList.h