xn::ProductionNode Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::ProductionNode:

List of all members.

Public Member Functions
XnStatus	AddNeededNode (ProductionNode &needed)
ErrorStateCapability	GetErrorStateCap ()
XnStatus	GetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, void *pBuffer) const
NodeInfo	GetInfo () const
XnStatus	GetIntProperty (const XnChar *strName, XnUInt64 &nValue) const
XnStatus	GetRealProperty (const XnChar *strName, XnDouble &dValue) const
XnStatus	GetStringProperty (const XnChar *strName, XnChar *csValue, XnUInt32 nBufSize) const
XnBool	IsCapabilitySupported (const XnChar *strCapabilityName) const
void	LockedNodeEndChanges (XnLockHandle hLock)
XnStatus	LockedNodeStartChanges (XnLockHandle hLock)
XnStatus	LockForChanges (XnLockHandle *phLock)
	ProductionNode (XnNodeHandle hNode=NULL)
XnStatus	Ref ()
XnStatus	RemoveNeededNode (ProductionNode &needed)
XnStatus	SetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, const void *pBuffer)
XnStatus	SetIntProperty (const XnChar *strName, XnUInt64 nValue)
XnStatus	SetRealProperty (const XnChar *strName, XnDouble dValue)
XnStatus	SetStringProperty (const XnChar *strName, const XnChar *strValue)
void	UnlockForChanges (XnLockHandle hLock)
void	Unref ()
void	GetContext (Context &context)

---

Detailed Description

Base class for all production nodes.

Definition at line 1548 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::ProductionNode::ProductionNode

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

Definition at line 1556 of file XnCppWrapper.h.

---

Member Function Documentation

XnStatus xn::ProductionNode::AddNeededNode

(

ProductionNode &

needed

)

[inline]

Adds another node to the list of needed nodes for this node.

For full details and usage, see xnAddNeededNode

Definition at line 1580 of file XnCppWrapper.h.

void xn::ProductionNode::GetContext

(

Context &

context

)

[inline]

Gets the context a node belongs to.

For full details and usage, see xnGetContextFromNodeHandle

Definition at line 4485 of file XnCppWrapper.h.

ErrorStateCapability xn::ProductionNode::GetErrorStateCap

(

)

[inline]

Gets an ErrorStateCapability object for accessing Error State functionality. It is the application responsibility to check first if XN_CAPABILITY_ERROR_STATE is supported by calling IsCapabilitySupported().

Definition at line 1707 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::GetGeneralProperty	(	const XnChar *	strName,
		XnUInt32	nBufferSize,
		void *	pBuffer
	)		const [inline]

Gets a buffer property.

For full details and usage, see xnGetGeneralProperty

Definition at line 1665 of file XnCppWrapper.h.

NodeInfo xn::ProductionNode::GetInfo

(

)

const [inline]

Gets information about a specific node, like its description, and dependent nodes.

For full details and usage, see xnGetNodeInfo

Definition at line 1561 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::GetIntProperty	(	const XnChar *	strName,
		XnUInt64 &	nValue
	)		const [inline]

Gets an integer property.

For full details and usage, see xnGetIntProperty

Definition at line 1641 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::GetRealProperty	(	const XnChar *	strName,
		XnDouble &	dValue
	)		const [inline]

Gets a real property.

For full details and usage, see xnGetRealProperty

Definition at line 1649 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::GetStringProperty	(	const XnChar *	strName,
		XnChar *	csValue,
		XnUInt32	nBufSize
	)		const [inline]

Gets a string property.

For full details and usage, see xnGetStringProperty

Definition at line 1657 of file XnCppWrapper.h.

XnBool xn::ProductionNode::IsCapabilitySupported

(

const XnChar *

strCapabilityName

)

const [inline]

Checks if a production node supports specific capability.

For full details and usage, see xnIsCapabilitySupported

Definition at line 1601 of file XnCppWrapper.h.

void xn::ProductionNode::LockedNodeEndChanges

(

XnLockHandle

hLock

)

[inline]

Ends changes request on a locked node.

For full details and usage, see xnLockedNodeEndChanges

Definition at line 1697 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::LockedNodeStartChanges

(

XnLockHandle

hLock

)

[inline]

Start changes request on a locked node, without releasing that lock.

For full details and usage, see xnLockedNodeStartChanges

Definition at line 1689 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::LockForChanges

(

XnLockHandle *

phLock

)

[inline]

Locks a node, not allowing any changes (any "set" function).

For full details and usage, see xnLockNodeForChanges

Definition at line 1673 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::Ref

(

)

[inline]

References a production node, increasing its reference count by 1.

For full details and usage, see xnRefProductionNode

Definition at line 1566 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::RemoveNeededNode

(

ProductionNode &

needed

)

[inline]

Removes a needed node from the list of needed nodes.

For full details and usage, see xnRemoveNeededNode

Definition at line 1588 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::SetGeneralProperty	(	const XnChar *	strName,
		XnUInt32	nBufferSize,
		const void *	pBuffer
	)		[inline]

Sets a buffer property.

For full details and usage, see xnSetGeneralProperty

Definition at line 1633 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::SetIntProperty	(	const XnChar *	strName,
		XnUInt64	nValue
	)		[inline]

Sets an integer property.

For full details and usage, see xnSetIntProperty

Definition at line 1609 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::SetRealProperty	(	const XnChar *	strName,
		XnDouble	dValue
	)		[inline]

Sets a real property.

For full details and usage, see xnSetRealProperty

Definition at line 1617 of file XnCppWrapper.h.

XnStatus xn::ProductionNode::SetStringProperty	(	const XnChar *	strName,
		const XnChar *	strValue
	)		[inline]

Sets a string property.

For full details and usage, see xnSetStringProperty

Definition at line 1625 of file XnCppWrapper.h.

void xn::ProductionNode::UnlockForChanges

(

XnLockHandle

hLock

)

[inline]

Unlocks a previously locked node.

For full details and usage, see xnUnlockNodeForChanges

Definition at line 1681 of file XnCppWrapper.h.

void xn::ProductionNode::Unref

(

)

[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 xnUnrefProductionNode

Definition at line 1571 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h