OpenNI 1.5.4: xn::NodeInfoList Class Reference

OpenNI

#include <XnCppWrapper.h>

List of all members.

Classes

class  Iterator

Public Member Functions

 NodeInfoList ()
 NodeInfoList (XnNodeInfoList *pList)
 ~NodeInfoList ()
XnNodeInfoListGetUnderlyingObject () const
void ReplaceUnderlyingObject (XnNodeInfoList *pList)
XnStatus Add (XnProductionNodeDescription &description, const XnChar *strCreationInfo, NodeInfoList *pNeededNodes)
XnStatus AddEx (XnProductionNodeDescription &description, const XnChar *strCreationInfo, NodeInfoList *pNeededNodes, const void *pAdditionalData, XnFreeHandler pFreeHandler)
XnStatus AddNode (NodeInfo &info)
XnStatus AddNodeFromAnotherList (Iterator &it)
Iterator Begin () const
Iterator End () const
Iterator RBegin () const
Iterator REnd () const
XnStatus Remove (Iterator &it)
XnStatus Clear ()
XnStatus Append (NodeInfoList &other)
XnBool IsEmpty ()
XnStatus FilterList (Context &context, Query &query)

Detailed Description

A NodeInfoList object contains a list of NodeInfo objects.


Constructor & Destructor Documentation

xn::NodeInfoList::NodeInfoList ( ) [inline]

Creates a new NodeInfoList object.

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:
[in]pListThe list to wrap.
xn::NodeInfoList::~NodeInfoList ( ) [inline]

Member Function Documentation

XnStatus xn::NodeInfoList::Add ( XnProductionNodeDescription description,
const XnChar *  strCreationInfo,
NodeInfoList pNeededNodes 
) [inline]
For full details and usage, see xnNodeInfoListAdd
XnStatus xn::NodeInfoList::AddEx ( XnProductionNodeDescription description,
const XnChar *  strCreationInfo,
NodeInfoList pNeededNodes,
const void *  pAdditionalData,
XnFreeHandler  pFreeHandler 
) [inline]
For full details and usage, see xnNodeInfoListAddEx
XnStatus xn::NodeInfoList::AddNode ( NodeInfo info) [inline]
For full details and usage, see xnNodeInfoListAddNode
XnStatus xn::NodeInfoList::AddNodeFromAnotherList ( Iterator it) [inline]
For full details and usage, see xnNodeInfoListAddNodeFromList
XnStatus xn::NodeInfoList::Append ( NodeInfoList other) [inline]
For full details and usage, see xnNodeInfoListAppend
Iterator xn::NodeInfoList::Begin ( ) const [inline]

Returns an iterator to the beginning of the list. If the list is empty, that iterator will be equal to NodeInfoList::End().

XnStatus xn::NodeInfoList::Clear ( ) [inline]
For full details and usage, see xnNodeInfoListClear
Iterator xn::NodeInfoList::End ( ) const [inline]

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

XnStatus xn::NodeInfoList::FilterList ( Context context,
Query query 
) [inline]
For full details and usage, see xnNodeQueryFilterList
XnNodeInfoList* xn::NodeInfoList::GetUnderlyingObject ( ) const [inline]

Gets the underlying C object.

XnBool xn::NodeInfoList::IsEmpty ( ) [inline]

Checks if the list NodeInfoList object is empty.

Iterator xn::NodeInfoList::RBegin ( ) const [inline]

Returns an iterator to the reverse beginning of the list. If the list is empty, that iterator will be equal to NodeInfoList::REnd().

XnStatus xn::NodeInfoList::Remove ( Iterator it) [inline]
For full details and usage, see xnNodeInfoListRemove
Iterator xn::NodeInfoList::REnd ( ) const [inline]

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

void xn::NodeInfoList::ReplaceUnderlyingObject ( XnNodeInfoList pList) [inline]

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

Parameters:
[in]pListThe list to wrap.

The documentation for this class was generated from the following file:
Generated on Wed May 16 2012 10:16:07 for OpenNI 1.5.4 by   doxygen 1.7.5.1