xn::ProductionNode Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::ProductionNode:

List of all members.

Public Member Functions
	ProductionNode (XnNodeHandle hNode=NULL)
	ProductionNode (const NodeWrapper &other)
NodeInfo	GetInfo () const
XnStatus	AddNeededNode (ProductionNode &needed)
XnStatus	RemoveNeededNode (ProductionNode &needed)
XnBool	IsCapabilitySupported (const XnChar *strCapabilityName) const
XnStatus	SetIntProperty (const XnChar *strName, XnUInt64 nValue)
XnStatus	SetRealProperty (const XnChar *strName, XnDouble dValue)
XnStatus	SetStringProperty (const XnChar *strName, const XnChar *strValue)
XnStatus	SetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, const void *pBuffer)
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
XnStatus	GetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, void *pBuffer) const
XnStatus	LockForChanges (XnLockHandle *phLock)
void	UnlockForChanges (XnLockHandle hLock)
XnStatus	LockedNodeStartChanges (XnLockHandle hLock)
void	LockedNodeEndChanges (XnLockHandle hLock)
const ErrorStateCapability	GetErrorStateCap () const
ErrorStateCapability	GetErrorStateCap ()
GeneralIntCapability	GetGeneralIntCap (const XnChar *strCapability)
void	GetContext (Context &context) const

---

Detailed Description

Base class for all production nodes.

---

Constructor & Destructor Documentation

xn::ProductionNode::ProductionNode

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

xn::ProductionNode::ProductionNode

(

const NodeWrapper &

other

)

[inline]

---

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

void xn::ProductionNode::GetContext

(

Context &

context

)

const [inline]

For full details and usage, see xnGetContextFromNodeHandle

const ErrorStateCapability xn::ProductionNode::GetErrorStateCap

(

)

const [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().

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().

GeneralIntCapability xn::ProductionNode::GetGeneralIntCap

(

const XnChar *

strCapability

)

[inline]

Gets an GeneralIntCapability object for accessing the capability functionality. It is the application responsibility to check first if the capability is supported by calling IsCapabilitySupported().

Parameters:

strCapability

[in] Name of the capability to get

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

Gets a buffer property.

For full details and usage, see xnGetGeneralProperty

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

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

Gets an integer property.

For full details and usage, see xnGetIntProperty

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

Gets a real property.

For full details and usage, see xnGetRealProperty

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

Gets a string property.

For full details and usage, see xnGetStringProperty

XnBool xn::ProductionNode::IsCapabilitySupported

(

const XnChar *

strCapabilityName

)

const [inline]

Checks if a production node supports specific capability.

For full details and usage, see xnIsCapabilitySupported

void xn::ProductionNode::LockedNodeEndChanges

(

XnLockHandle

hLock

)

[inline]

Ends changes request on a locked node.

For full details and usage, see xnLockedNodeEndChanges

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

XnStatus xn::ProductionNode::LockForChanges

(

XnLockHandle *

phLock

)

[inline]

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

For full details and usage, see xnLockNodeForChanges

XnStatus xn::ProductionNode::RemoveNeededNode

(

ProductionNode &

needed

)

[inline]

Removes a needed node from the list of needed nodes.

For full details and usage, see xnRemoveNeededNode

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

Sets a buffer property.

For full details and usage, see xnSetGeneralProperty

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

Sets an integer property.

For full details and usage, see xnSetIntProperty

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

Sets a real property.

For full details and usage, see xnSetRealProperty

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

Sets a string property.

For full details and usage, see xnSetStringProperty

void xn::ProductionNode::UnlockForChanges

(

XnLockHandle

hLock

)

[inline]

Unlocks a previously locked node.

For full details and usage, see xnUnlockNodeForChanges

---

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

• XnCppWrapper.h