xn::NodeInfo Class Reference
[Managing the Production Graph]

#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
NodeInfoListGetNeededNodes () const
XnStatus GetInstance (ProductionNode &node) const
const void * GetAdditionalData () const
XnStatus GetTreeStringRepresentation (XnChar *csResultBuffer, XnUInt32 nBufferSize) const

Friends

class Context

Detailed Description

Purpose: This class provides functionality for getting information about a node alternative. A Node Alternative is either an existing node, or a not-yet instantiated alternative.

Remarks:

Each instantiated node has a NodeInfo object and it can be accessed through the xn::ProductionNode::GetInfo() method.


Constructor & Destructor Documentation

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

Ctor

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

Copy Ctor

Parameters:
[in] other An object to copy from.
xn::NodeInfo::~NodeInfo (  )  [inline]

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]

Gets the creation information of the node alternative.

Remarks

A node's creation information is a way for a node implementation to have two distinct instances of the same node class, that is two nodes. For example, a Device node implementation can use this field for the name of the device it represents, so that if two sensors are connected, each will have a different value here.

const XnProductionNodeDescription& xn::NodeInfo::GetDescription (  )  const [inline]

Gets the description of a node alternative.

Remarks

When you instantiate a production node object -- for example a DepthGenerator -- you cannot access it's NodeInfo object until after Create() has been called.

However - you can also get NodeInfo objects by enumeration, for example, from the EnumerateProductionTrees() method.

XnStatus xn::NodeInfo::GetInstance ( ProductionNode node  )  const [inline]

Gets a reference to the node instance represented by this node alternative.

Parameters:
node [in/out] The 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]

Gets the instance name of a node alternative.

Remarks

When you instantiate a DepthGenerator object, for example, you cannot access it's NodeInfo object until after its Create() method has been called.

However - you can also get NodeInfo objects by enumeration, for example, from the EnumerateProductionTrees() method.

NodeInfoList & xn::NodeInfo::GetNeededNodes (  )  const [inline]
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:
[in] other another object
XnStatus xn::NodeInfo::SetInstanceName ( const XnChar *  strName  )  [inline]

Sets the instance name of the NodeInfo object. The name can only be set before the instance is created.

Parameters:
[in] strName Name to give to this instance.

Friends And Related Function Documentation

friend class Context [friend]

The documentation for this class was generated from the following file:
Generated on Thu Dec 20 21:49:31 2012 for OpenNI 1.5.4 by  doxygen 1.6.3