OpenNI 1.0.0
Public Member Functions | Protected Attributes
xn::OutputMetaData Class Reference

#include <XnCppWrapper.h>

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

List of all members.

Public Member Functions

 OutputMetaData (const XnUInt8 **ppData)
virtual ~OutputMetaData ()
XnUInt64 Timestamp () const
XnUInt64 & Timestamp ()
XnUInt32 FrameID () const
XnUInt32 & FrameID ()
XnUInt32 DataSize () const
XnUInt32 & DataSize ()
XnBool IsDataNew () const
XnBool & IsDataNew ()
const XnOutputMetaDataGetUnderlying () const
XnOutputMetaDataGetUnderlying ()
const XnUInt8 * Data () const
const XnUInt8 *& Data ()
XnUInt8 * WritableData ()
XnStatus AllocateData (XnUInt32 nBytes)
void Free ()
XnStatus MakeDataWritable ()

Protected Attributes

XnUInt8 * m_pAllocatedData

Detailed Description

Represents the basic MetaData object.


Constructor & Destructor Documentation

xn::OutputMetaData::OutputMetaData ( const XnUInt8 **  ppData) [inline]

Ctor. Meant to be used by other MetaData objects.

Parameters:
ppData[in] A pointer to the data member of the meta data object.
virtual xn::OutputMetaData::~OutputMetaData ( ) [inline, virtual]

Dtor. Frees any allocated data.


Member Function Documentation

XnStatus xn::OutputMetaData::AllocateData ( XnUInt32  nBytes) [inline]

Allocated a writable buffer. If a previous buffer was allocated it will be freed (or reused if possible). Also see Meta Data Objects.

Parameters:
nBytes[in] The requested size for the buffer, in bytes.
const XnUInt8* xn::OutputMetaData::Data ( ) const [inline]

Gets a pointer to the data.

Reimplemented in xn::SceneMetaData, xn::IRMetaData, and xn::DepthMetaData.

const XnUInt8*& xn::OutputMetaData::Data ( ) [inline]

Gets a pointer to the data.

Reimplemented in xn::SceneMetaData, xn::IRMetaData, and xn::DepthMetaData.

XnUInt32 xn::OutputMetaData::DataSize ( ) const [inline]

Gets the data size, in bytes

XnUInt32& xn::OutputMetaData::DataSize ( ) [inline]

Gets the data size, in bytes

XnUInt32 xn::OutputMetaData::FrameID ( ) const [inline]

Gets the frame ID

XnUInt32& xn::OutputMetaData::FrameID ( ) [inline]

Gets the frame ID

void xn::OutputMetaData::Free ( ) [inline]

Frees the writable buffer, if one was allocated.

Gets the C object that is wrapped by this object.

Reimplemented in xn::SceneMetaData, xn::AudioMetaData, xn::IRMetaData, xn::ImageMetaData, xn::DepthMetaData, and xn::MapMetaData.

Gets the C object that is wrapped by this object.

Reimplemented in xn::SceneMetaData, xn::AudioMetaData, xn::IRMetaData, xn::ImageMetaData, xn::DepthMetaData, and xn::MapMetaData.

XnBool xn::OutputMetaData::IsDataNew ( ) const [inline]

TRUE if data was updated since last call to any Update function.

XnBool& xn::OutputMetaData::IsDataNew ( ) [inline]

TRUE if data was updated since last call to any Update function.

Allocates a buffer and copies current data to it, so that data can be edited. Also see Meta Data Objects.

XnUInt64 xn::OutputMetaData::Timestamp ( ) const [inline]

Gets the timestamp

XnUInt64& xn::OutputMetaData::Timestamp ( ) [inline]

Gets the timestamp

XnUInt8* xn::OutputMetaData::WritableData ( ) [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

Reimplemented in xn::SceneMetaData, xn::IRMetaData, xn::ImageMetaData, and xn::DepthMetaData.


Member Data Documentation


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