xn::NodeWrapper Class Reference
[C++ Reference]

#include <XnCppWrapper.h>

Inheritance diagram for xn::NodeWrapper:
[legend]

List of all members.

Public Member Functions

 NodeWrapper (XnNodeHandle hNode)
 NodeWrapper (const NodeWrapper &other)
NodeWrapperoperator= (const NodeWrapper &other)
 ~NodeWrapper ()
 operator XnNodeHandle () const
XnNodeHandle GetHandle () const
XnBool operator== (const NodeWrapper &other)
XnBool operator!= (const NodeWrapper &other)
XnBool IsValid () const
const XnChar * GetName () const
XnStatus AddRef ()
void Release ()
XnStatus Ref ()
void Unref ()
void SetHandle (XnNodeHandle hNode)
void TakeOwnership (XnNodeHandle hNode)

Friends

class Context

Detailed Description

Base class for all node wrappers


Constructor & Destructor Documentation

xn::NodeWrapper::NodeWrapper ( XnNodeHandle  hNode  )  [inline]

Ctor

Parameters:
hNode [in] A node handle.
xn::NodeWrapper::NodeWrapper ( const NodeWrapper other  )  [inline]
xn::NodeWrapper::~NodeWrapper (  )  [inline]

Member Function Documentation

XnStatus xn::NodeWrapper::AddRef (  )  [inline]

References a production node, increasing its reference count by 1. For full details and usage, see xnProductionNodeAddRef

XnNodeHandle xn::NodeWrapper::GetHandle (  )  const [inline]

Gets the underlying C handle.

const XnChar* xn::NodeWrapper::GetName (  )  const [inline]

Gets the instance name of a node by its handle. For full details and usage, see xnGetNodeName()

XnBool xn::NodeWrapper::IsValid (  )  const [inline]

TRUE if the object points to an actual node, FALSE otherwise.

xn::NodeWrapper::operator XnNodeHandle (  )  const [inline]
XnBool xn::NodeWrapper::operator!= ( const NodeWrapper other  )  [inline]

Checks if two node wrappers point to different objects.

Parameters:
other [in] Another object
NodeWrapper& xn::NodeWrapper::operator= ( const NodeWrapper other  )  [inline]
XnBool xn::NodeWrapper::operator== ( const NodeWrapper other  )  [inline]

Checks if two node wrappers point to the same object.

Parameters:
other [in] Another object
XnStatus xn::NodeWrapper::Ref (  )  [inline]
void xn::NodeWrapper::Release (  )  [inline]

Unreference a production node, decreasing its reference count by 1. If the reference count reaches zero, the node will be destroyed. For full details and usage, see xnProductionNodeRelease

void xn::NodeWrapper::SetHandle ( XnNodeHandle  hNode  )  [inline]

Replaces the object being pointed.

void xn::NodeWrapper::TakeOwnership ( XnNodeHandle  hNode  )  [inline]
void xn::NodeWrapper::Unref (  )  [inline]

Friends And Related Function Documentation

friend class Context [friend]

The documentation for this class was generated from the following file:
Generated on Fri Nov 9 22:59:09 2012 for OpenNI 1.3.2 by  doxygen 1.6.3