OpenNI 1.5.4
Public Member Functions | List of all members
xn::Device Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::Device:
Inheritance graph
[legend]

Public Member Functions

 Device (XnNodeHandle hNode=NULL)
 
 Device (const NodeWrapper &other)
 
XnStatus Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)
 
DeviceIdentificationCapability GetIdentificationCap ()
 
- Public Member Functions inherited from xn::ProductionNode
 ProductionNode (XnNodeHandle hNode=NULL)
 
 ProductionNode (const NodeWrapper &other)
 
NodeInfo GetInfo () const
 
XnStatus AddNeededNode (ProductionNode &needed)
 
XnStatus RemoveNeededNode (ProductionNode &needed)
 
void GetContext (Context &context) const
 
Context GetContext () const
 
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)
 
- Public Member Functions inherited from xn::NodeWrapper
 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 ()
 
void SetHandle (XnNodeHandle hNode)
 
void TakeOwnership (XnNodeHandle hNode)
 

Detailed Description

Purpose: A smart pointer to a device node in the production graph of a context.

The device node represents a physical hardware device currently connected in the system and used for generating data. The Device node represents the hardware device by providing, for example, the device's model name, serial number, and some vendor-specific data. The Device node itself does not generate data.

Capabilities: DeviceIdentificationCapability

Constructor & Destructor Documentation

xn::Device::Device ( XnNodeHandle  hNode = NULL)
inline
xn::Device::Device ( const NodeWrapper other)
inline

Member Function Documentation

XnStatus xn::Device::Create ( Context context,
Query pQuery = NULL,
EnumerationErrors pErrors = NULL 
)
inline

Creates a Device node from available production node alternatives.

Remarks

See Concepts: the Create() Method for a detailed description of the operation of this method.

DeviceIdentificationCapability xn::Device::GetIdentificationCap ( )
inline

Gets a DeviceIdentificationCapability object for accessing device identification functionality.

Remarks

If this node supports this method then the node can identify which device is being used right now, for example, its name, serial number, and specific vendors can place specific data.

It is the application's responsibility to check first if XN_CAPABILITY_DEVICE_IDENTIFICATION is supported by calling IsCapabilitySupported().


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