OpenNI 1.5.4: xn::DeviceIdentificationCapability Class Reference

OpenNI

xn::DeviceIdentificationCapability Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::DeviceIdentificationCapability:

List of all members.

Public Member Functions

 DeviceIdentificationCapability (XnNodeHandle hNode)
 DeviceIdentificationCapability (const NodeWrapper &node)
XnStatus GetDeviceName (XnChar *strBuffer, XnUInt32 nBufferSize)
XnStatus GetVendorSpecificData (XnChar *strBuffer, XnUInt32 nBufferSize)
XnStatus GetSerialNumber (XnChar *strBuffer, XnUInt32 nBufferSize)

Detailed Description

Purpose: The DeviceIdentificationCapability object allows an application to receive some device-specific information about a hardware device, like its serial number and its model name.

Usage: Do not instantiate directly. Instead, use Device::GetIdentificationCap() to obtain an instance.


Constructor & Destructor Documentation

xn::DeviceIdentificationCapability::DeviceIdentificationCapability ( XnNodeHandle  hNode) [inline]

Ctor

Parameters:
[in]hNodeNode handle
xn::DeviceIdentificationCapability::DeviceIdentificationCapability ( const NodeWrapper node) [inline]

Member Function Documentation

XnStatus xn::DeviceIdentificationCapability::GetDeviceName ( XnChar *  strBuffer,
XnUInt32  nBufferSize 
) [inline]

Gets the name of the device holding this capability object.

Parameters:
[in]strBufferBuffer to accept the device information.
[in,out]nBufferSizeSize of the buffer.
Return values:
XN_STATUS_OKOperation succeeded.
XN_STATUS_OUTPUT_BUFFER_OVERFLOWThe size of the buffer is not sufficient.
XnStatus xn::DeviceIdentificationCapability::GetSerialNumber ( XnChar *  strBuffer,
XnUInt32  nBufferSize 
) [inline]

Gets the vendor-specific name of the device holding this capability object.

Parameters:
[in]strBufferBuffer to accept the serial number
[in,out]nBufferSizeSize of the buffer.
Return values:
XN_STATUS_OKOperation succeeded.
XN_STATUS_OUTPUT_BUFFER_OVERFLOWThe size of the buffer is not sufficient.
XnStatus xn::DeviceIdentificationCapability::GetVendorSpecificData ( XnChar *  strBuffer,
XnUInt32  nBufferSize 
) [inline]

Gets the vendor-specific name of the device holding this capability object.

Parameters:
[in]strBufferBuffer to accept the device information.
[in,out]nBufferSizeSize of the buffer.
Return values:
XN_STATUS_OKOperation succeeded.
XN_STATUS_OUTPUT_BUFFER_OVERFLOWThe size of the buffer is not sufficient.

The documentation for this class was generated from the following file:
Generated on Wed May 16 2012 10:16:07 for OpenNI 1.5.4 by   doxygen 1.7.5.1