OpenNI 1.5.2
Public Member Functions | Friends
xn::NodeInfo Class Reference

#include <XnCppWrapper.h>

List of all members.

Public Member Functions

 NodeInfo (XnNodeInfo *pInfo)
 NodeInfo (const NodeInfo &other)
 ~NodeInfo ()
NodeInfooperator= (const NodeInfo &other)
 operator XnNodeInfo * ()
XnStatus SetInstanceName (const XnChar *strName)
const XnProductionNodeDescriptionGetDescription () const
const XnChar * GetInstanceName () const
const XnChar * GetCreationInfo () const
const void * GetAdditionalData () const
XnStatus GetTreeStringRepresentation (XnChar *csResultBuffer, XnUInt32 nBufferSize) const

Friends

class Context
NodeInfoListGetNeededNodes () const
XnStatus GetInstance (ProductionNode &node) const

Detailed Description

Represents information about an existing node, or a possibility of a node.


Constructor & Destructor Documentation

xn::NodeInfo::NodeInfo ( XnNodeInfo pInfo) [inline]

Ctor

Parameters:
pInfo[in] The C object to wrap
xn::NodeInfo::NodeInfo ( const NodeInfo other) [inline]

Copy Ctor

Parameters:
other[in] An object to copy from.

Dtor.


Member Function Documentation

const void* xn::NodeInfo::GetAdditionalData ( ) const [inline]
For full details and usage, see xnNodeInfoGetAdditionalData

const XnChar* xn::NodeInfo::GetCreationInfo ( ) const [inline]
For full details and usage, see xnNodeInfoGetCreationInfo

For full details and usage, see xnNodeInfoGetDescription()

Gets the node instance represented by this info object.

Parameters:
node[in] A production node to be pointing to the node.
Returns:
an error if this node info object does not point to an actual node.
const XnChar* xn::NodeInfo::GetInstanceName ( ) const [inline]
For full details and usage, see xnNodeInfoGetInstanceName()

For full details and usage, see xnNodeInfoGetNeededNodes

XnStatus xn::NodeInfo::GetTreeStringRepresentation ( XnChar *  csResultBuffer,
XnUInt32  nBufferSize 
) const [inline]
For full details and usage, see xnNodeInfoGetTreeStringRepresentation

xn::NodeInfo::operator XnNodeInfo * ( ) [inline]

Gets the underlying C object.

NodeInfo& xn::NodeInfo::operator= ( const NodeInfo other) [inline]

Assignment operator

Parameters:
other[in] another object
XnStatus xn::NodeInfo::SetInstanceName ( const XnChar *  strName) [inline]
For full details and usage, see xnNodeInfoSetInstanceName


Friends And Related Function Documentation

friend class Context [friend]

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