#include <XnCppWrapper.h>
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.
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 |
const void* xn::NodeInfo::GetAdditionalData |
( |
) | |
const |
|
inline |
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.
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.
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.
XnStatus xn::NodeInfo::GetTreeStringRepresentation |
( |
XnChar * |
csResultBuffer, |
|
|
XnUInt32 |
nBufferSize |
|
) |
| const |
|
inline |
Gets the underlying C object
Assignment operator
- Parameters
-
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. |
The documentation for this class was generated from the following file: