NITE 1.5.1 - API Reference

XnVMessage Class Reference

#include <XnVMessage.h>

Inheritance diagram for XnVMessage:

List of all members.

Public Member Functions

 XnVMessage (const XnChar *strType, void *pData)
virtual ~XnVMessage ()
void * GetData ()
virtual XnVMessageoperator[] (const XnChar *strType)
const XnChar * GetType () const
virtual XnVMessageClone () const =0

Protected Attributes

XnChar * m_strType
void * m_pData
XnBool m_bFreeOnDestruction

Detailed Description

A XnVMessage is a general Message that holds some data. It will be sent between Generators and Listeners, thus passing data along the framework

Definition at line 25 of file XnVMessage.h.


Constructor & Destructor Documentation

XnVMessage::XnVMessage ( const XnChar *  strType,
void *  pData 
)

Constructor. Create a new Message, with a specific type and data

Parameters:
[in]strTypeThe type of this Message
[in]pDatathe data of this Message
virtual XnVMessage::~XnVMessage ( ) [virtual]

Member Function Documentation

virtual XnVMessage* XnVMessage::Clone ( ) const [pure virtual]

Abstract function. Any Message should know how to clone itself, along with its internal data

Returns:
A new message with the same data

Implemented in XnVCCMessage, XnVComplexMessage, XnVDepthMessage, XnVContextMessage, XnVImageMessage, XnVPointMessage, and XnVSessionMessage.

void* XnVMessage::GetData ( )

Get the inner data

Returns:
The data in the Message
const XnChar* XnVMessage::GetType ( ) const

Get the type of this message

Returns:
The type of the Message
virtual XnVMessage* XnVMessage::operator[] ( const XnChar *  strType) [virtual]

Get the Message of this type that in there. Will generally return itself if the types match

Parameters:
[in]strTypeThe type of the requested Message
Returns:
A message of this type, or NULL if one doesn't exist

Reimplemented in XnVComplexMessage.


Member Data Documentation

Definition at line 70 of file XnVMessage.h.

void* XnVMessage::m_pData [protected]

Definition at line 68 of file XnVMessage.h.

XnChar* XnVMessage::m_strType [protected]

Definition at line 67 of file XnVMessage.h.


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