xn::NodeInfoList Class Reference

#include <XnCppWrapper.h>

List of all members.

Classes
class	Iterator
	Represents an iterator over a NodeInfoList list. More...
Public Member Functions
XnStatus	Add (XnProductionNodeDescription &description, const XnChar *strCreationInfo, NodeInfoList *pNeededNodes)
XnStatus	AddNode (NodeInfo &info)
XnStatus	AddNodeFromAnotherList (Iterator &it)
XnStatus	Append (NodeInfoList &other)
Iterator	Begin () const
	Gets an iterator to the first item in the list.
XnStatus	Clear ()
Iterator	End () const
	Gets an iterator marking the end of the list. This iterator does not point to a valid item.
XnNodeInfoList *	GetUnderlyingObject () const
	Gets the underlying C object.
XnBool	IsEmpty ()
	NodeInfoList ()
	NodeInfoList (XnNodeInfoList *pList)
Iterator	RBegin () const
	Gets an iterator to the last item in the list.
XnStatus	Remove (Iterator &it)
Iterator	REnd () const
	Gets an iterator marking the start of the list. This iterator does not point to a valid item.
void	ReplaceUnderlyingObject (XnNodeInfoList *pList)
	~NodeInfoList ()
	Dtor.
XnStatus	FilterList (Context &context, Query &query)
Private Member Functions
void	FreeImpl ()
Private Attributes
XnBool	m_bAllocated
XnNodeInfoList *	m_pList

---

Detailed Description

Represents a list of NodeInfo objects.

Definition at line 1231 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::NodeInfoList::NodeInfoList

(

)

[inline]

Creates a new NodeInfoList object.

Definition at line 1333 of file XnCppWrapper.h.

xn::NodeInfoList::NodeInfoList

(

XnNodeInfoList *

pList

)

[inline]

Creates a new NodeInfoList object by wrapping a C XnNodeInfoList object. Note that this list will not be freed upon destruction.

Parameters:

pList

[in] The list to wrap.

Definition at line 1345 of file XnCppWrapper.h.

xn::NodeInfoList::~NodeInfoList

(

)

[inline]

Dtor.

Definition at line 1348 of file XnCppWrapper.h.

---

Member Function Documentation

XnStatus xn::NodeInfoList::Add	(	XnProductionNodeDescription &	description,
		const XnChar *	strCreationInfo,
		NodeInfoList *	pNeededNodes
	)		[inline]

For full details and usage, see xnNodeInfoListAdd

Definition at line 1373 of file XnCppWrapper.h.

XnStatus xn::NodeInfoList::AddNode

(

NodeInfo &

info

)

[inline]

For full details and usage, see xnNodeInfoListAddNode

Definition at line 1382 of file XnCppWrapper.h.

XnStatus xn::NodeInfoList::AddNodeFromAnotherList

(

Iterator &

it

)

[inline]

For full details and usage, see xnNodeInfoListAddNodeFromList

Definition at line 1390 of file XnCppWrapper.h.

XnStatus xn::NodeInfoList::Append

(

NodeInfoList &

other

)

[inline]

For full details and usage, see xnNodeInfoListAppend

Definition at line 1440 of file XnCppWrapper.h.

Iterator xn::NodeInfoList::Begin

(

)

const [inline]

Gets an iterator to the first item in the list.

Definition at line 1396 of file XnCppWrapper.h.

XnStatus xn::NodeInfoList::Clear

(

)

[inline]

For full details and usage, see xnNodeInfoListClear

Definition at line 1432 of file XnCppWrapper.h.

Iterator xn::NodeInfoList::End

(

)

const [inline]

Gets an iterator marking the end of the list. This iterator does not point to a valid item.

Definition at line 1402 of file XnCppWrapper.h.

XnStatus xn::NodeInfoList::FilterList	(	Context &	context,
		Query &	query
	)		[inline]

For full details and usage, see xnNodeQueryFilterList

Definition at line 4480 of file XnCppWrapper.h.

void xn::NodeInfoList::FreeImpl

(

)

[inline, private]

Definition at line 1459 of file XnCppWrapper.h.

XnNodeInfoList* xn::NodeInfoList::GetUnderlyingObject

(

)

const [inline]

Gets the underlying C object.

Definition at line 1354 of file XnCppWrapper.h.

XnBool xn::NodeInfoList::IsEmpty

(

)

[inline]

For full details and usage, see xnNodeInfoListIsEmpty

Definition at line 1448 of file XnCppWrapper.h.

Iterator xn::NodeInfoList::RBegin

(

)

const [inline]

Gets an iterator to the last item in the list.

Definition at line 1409 of file XnCppWrapper.h.

XnStatus xn::NodeInfoList::Remove

(

Iterator &

it

)

[inline]

For full details and usage, see xnNodeInfoListRemove

Definition at line 1424 of file XnCppWrapper.h.

Iterator xn::NodeInfoList::REnd

(

)

const [inline]

Gets an iterator marking the start of the list. This iterator does not point to a valid item.

Definition at line 1415 of file XnCppWrapper.h.

void xn::NodeInfoList::ReplaceUnderlyingObject

(

XnNodeInfoList *

pList

)

[inline]

Replaces the underlying object, taking ownership of the object (meaning, it will be freed upon destruction).

Parameters:

pList

[in] The list to wrap.

Definition at line 1362 of file XnCppWrapper.h.

---

Member Data Documentation

XnBool xn::NodeInfoList::m_bAllocated [private]

Definition at line 1470 of file XnCppWrapper.h.

XnNodeInfoList* xn::NodeInfoList::m_pList [private]

Definition at line 1469 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h