NITE 1.5.1 - API Reference

XnVCCMessage Class Reference

#include <XnVCCMessage.h>

Inheritance diagram for XnVCCMessage:
Collaboration diagram for XnVCCMessage:

List of all members.

Public Member Functions

 XnVCCMessage (const XnChar *strType, XnBool bValue)
 ~XnVCCMessage ()
XnVMessageClone () const
XnBool GetValue () const

Static Public Member Functions

static XnStatus GetValue (XnVMessage *pMessage, const XnChar *strType, XnBool &bValue)

Protected Attributes

XnBool m_bValue

Detailed Description

A generic Message holding a single boolean value, basically for command and control (CC)

Definition at line 17 of file XnVCCMessage.h.


Constructor & Destructor Documentation

XnVCCMessage::XnVCCMessage ( const XnChar *  strType,
XnBool  bValue 
)

Constructor. Create a CC Message with a boolean and a specific type

Parameters:
[in]strTypeThe type of the C&C Message
[in]bValueThe internal value
XnVCCMessage::~XnVCCMessage ( )

Member Function Documentation

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

Create a new Message of the same type (CC Message), with a clone of the same data (the same boolean value)

Returns:
The new message

Implements XnVMessage.

Reimplemented in XnVSessionMessage.

static XnStatus XnVCCMessage::GetValue ( XnVMessage pMessage,
const XnChar *  strType,
XnBool &  bValue 
) [static]
XnBool XnVCCMessage::GetValue ( ) const

Get the internal value

Returns:
The internal value

Member Data Documentation

XnBool XnVCCMessage::m_bValue [protected]

Definition at line 46 of file XnVCCMessage.h.


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