NITE 1.5.1 - API Reference

XnVFlowRouter Class Reference

#include <XnVFlowRouter.h>

Inheritance diagram for XnVFlowRouter:
Collaboration diagram for XnVFlowRouter:

List of all members.

Public Member Functions

 XnVFlowRouter (const XnChar *strName="XnVFlowRouter")
virtual ~XnVFlowRouter ()
XnStatus SetActive (XnVMessageListener *pActive)
XnVMessageListenerGetActive () const
void Update (XnVMessage *pMessage)
void ClearQueue ()

Protected Member Functions

virtual void CloseOldSession ()
virtual void OpenNewSession ()

Protected Attributes

XnVMessageListenerm_pActive
XnStringsHash * m_pProperties

Detailed Description

A XnVFlowRouter is a Message Listener, that holds another single Listener internally, and sends any Message it gets to that Listener. The single internal Listener (referred to as the Active Control) may be changed, thus enabling to create the application's automaton.

Definition at line 22 of file XnVFlowRouter.h.


Constructor & Destructor Documentation

XnVFlowRouter::XnVFlowRouter ( const XnChar *  strName = "XnVFlowRouter")

Constructor. Create a new Flow Router

Parameters:
[in]strNameName of the control, for log purposes.
virtual XnVFlowRouter::~XnVFlowRouter ( ) [virtual]

Member Function Documentation

void XnVFlowRouter::ClearQueue ( ) [virtual]

Clear the Multi-threading queue

Reimplemented from XnVMessageListener.

virtual void XnVFlowRouter::CloseOldSession ( ) [protected, virtual]
XnVMessageListener* XnVFlowRouter::GetActive ( ) const

Get the current active Control

Returns:
The current active Control
virtual void XnVFlowRouter::OpenNewSession ( ) [protected, virtual]
XnStatus XnVFlowRouter::SetActive ( XnVMessageListener pActive)

Change the active Control. If a session is kept, it is closed to the old Active Control (CloseOldSession), and then opened to the new Active Control (OpenNewSession)

Parameters:
[in]pActiveThe new Active Control
void XnVFlowRouter::Update ( XnVMessage pMessage) [virtual]

Send any Message received to the active Control

Parameters:
[in]pMessageThe Message to route to the active Control

Implements XnVMessageListener.


Member Data Documentation

Definition at line 63 of file XnVFlowRouter.h.

XnStringsHash* XnVFlowRouter::m_pProperties [protected]

Definition at line 65 of file XnVFlowRouter.h.


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