ot::CallforwardNode Class Reference
[Common Classes]

#include <CallforwardNode.h>

Inheritance diagram for ot::CallforwardNode:

[legend]Collaboration diagram for ot::CallforwardNode:

[legend]List of all members.

---

Detailed Description

This class implements a simple node that stores an event and passes an eventually pending event, each time it is traversed.

Author:

Alexander Bornik

Public Member Functions
virtual int	isEventGenerator ()
virtual void	updateObservers (Event &data)
const std::string &	getCallforwardName (void) const
void	setEvent (const Event &inevent)
Public Attributes
std::string	name
bool	pendingevent
	flag, whether a new event has been set
Event	event
	the event set by the uses
CallforwardModule *	cfmodule
	pointer to creating module CallforwardModule
mutex_type	cfmutex
	used for mutual exclusive access to the pending events
Protected Member Functions
	CallforwardNode (const std::string &name_)
Friends
class	CallforwardModule

---

Constructor & Destructor Documentation

ot::CallforwardNode::CallforwardNode (  const std::string &  name_  )  [inline, protected]

constructor method,sets commend member Parameters: name_  the name of the Callforward node

---

Member Function Documentation

const std::string& ot::CallforwardNode::getCallforwardName (  void   )  const [inline]

This method returns the value set by the name attribute of the Callforward node. This is a different value then the one returned by getName(), which is the value set by the attribute DEF. Returns: reference to the name string.

virtual int ot::CallforwardNode::isEventGenerator (   )  [inline, virtual]

tests for EventGenerator interface being present. Is overriden to return 1 always. Returns: always 1 Reimplemented from ot::Node.

void ot::CallforwardNode::setEvent (  const Event &  inevent  )  [inline]

method to set the event to be pushed into the graph the lock ensures threadsafe event setting

virtual void ot::CallforwardNode::updateObservers (  Event &  data  )  [inline, virtual]

overridden from node only updates the observers in case of a new event ensures mutual exclusive acces to the event Reimplemented from ot::Node.

---

Friends And Related Function Documentation

friend class CallforwardModule [friend]

---

Member Data Documentation

CallforwardModule* ot::CallforwardNode::cfmodule

pointer to creating module CallforwardModule

mutex_type ot::CallforwardNode::cfmutex

used for mutual exclusive access to the pending events

Event ot::CallforwardNode::event

the event set by the uses

std::string ot::CallforwardNode::name

name of the CallforwardNode for retrieving it from the module. Note that this is not the name returned by getName(), rather the value set by the attribute name. Reimplemented from ot::Node.

bool ot::CallforwardNode::pendingevent

flag, whether a new event has been set

---

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

• include/OpenTracker/common/CallforwardNode.h

---