OpenNI 1.5.4
Classes | Public Member Functions | List of all members
xn::NodeInfoList Class Reference

#include <XnCppWrapper.h>

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
XnStatus xn::NodeInfoList::AddEx ( XnProductionNodeDescription description,
const XnChar *  strCreationInfo,
NodeInfoList pNeededNodes,
const void *  pAdditionalData,
XnFreeHandler  pFreeHandler 
)
inline
XnStatus xn::NodeInfoList::AddNode ( NodeInfo info)
inline
XnStatus xn::NodeInfoList::AddNodeFromAnotherList ( Iterator it)
inline
XnStatus xn::NodeInfoList::Append ( NodeInfoList other)
inline
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
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
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
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: