xn::OutputMetaData Class Reference
[C++ Reference]

#include <XnCppWrapper.h>

Inheritance diagram for xn::OutputMetaData:
[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 (  )  [inline]

Gets a pointer to the data.

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

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

Gets a pointer to the data.

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

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

Gets the data size, in bytes

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

Gets the data size, in bytes

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

Gets the frame ID

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

Gets the frame ID

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

Frees the writable buffer, if one was allocated.

XnOutputMetaData* xn::OutputMetaData::GetUnderlying (  )  [inline]

Gets the C object that is wrapped by this object.

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

const XnOutputMetaData* xn::OutputMetaData::GetUnderlying (  )  const [inline]

Gets the C object that is wrapped by this object.

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

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

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

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

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

XnStatus xn::OutputMetaData::MakeDataWritable (  )  [inline]

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

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

Gets the timestamp

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

Gets the timestamp

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

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

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


Member Data Documentation


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

Generated on 11 Feb 2011 for OpenNI 1.0.0 by  doxygen 1.6.1