ot::CallforwardModule Class Reference
[Common Classes]

#include <CallforwardModule.h>

Inheritance diagram for ot::CallforwardModule:

[legend]Collaboration diagram for ot::CallforwardModule:

[legend]List of all members.

---

Detailed Description

The module and factory to drive the callforward nodes. It constructs Callforward nodes via the NodeFactory interface and registers

Author:

Alexander Bornik

Public Member Functions
	CallforwardModule ()
virtual	~CallforwardModule ()
virtual Node *	createNode (const std::string &name, StringTable &attributes)
bool	callForward (const std::string &name, Event &event)
virtual void	pushEvent ()
Protected Attributes
NodeMap	nodes
	map of strings onto nodes

---

Constructor & Destructor Documentation

ot::CallforwardModule::CallforwardModule (   )  [inline]

constructor method.

virtual ot::CallforwardModule::~CallforwardModule (   )  [inline, virtual]

Destructor method, clears nodes member.

---

Member Function Documentation

bool ot::CallforwardModule::callForward (  const std::string &  name, Event &  event )

Registers a user provided event to be transported through the graph. This call is thread safe. The event can be produced outside the OpenTracker loop thread. Parameters: name  of the Callforward node to push the event in reference  to the user provided event

Node * ot::CallforwardModule::createNode (  const std::string &  name, StringTable &  attributes )  [virtual]

This method is called to construct a new Node. It compares name to the Callforward element name, and if it matches creates a new Callforward node. * Parameters: name  reference to string containing element name reference to StringMap containing attribute values Returns: pointer to new Node or NULL. The new Node must be allocated with new ! Implements ot::NodeFactory.

void ot::CallforwardModule::pushEvent (   )  [virtual]

pushes events into the tracker tree. Determines, whether the user has set an Event via the callForward method and passes the events on in that case. Reimplemented from ot::Module.

---

Member Data Documentation

NodeMap ot::CallforwardModule::nodes [protected]

map of strings onto nodes

---

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

• include/OpenTracker/common/CallforwardModule.h
• src/common/CallforwardModule.cxx

---