ot::EventUtilityNode Class Reference
[Common Classes]

#include <EventUtilityNode.h>

Inheritance diagram for ot::EventUtilityNode:

[legend]Collaboration diagram for ot::EventUtilityNode:

[legend]List of all members.

---

Detailed Description

The EventUtilityNode provides the possibility to rename, discard, or add attributes to every event passed to this node.

Author:

Jochen von Spiczak

Public Member Functions
virtual int	isEventGenerator ()
virtual void	onEventGenerated (Event &event, Node &generator)
void	setRename (const std::string &oldName, const std::string &newName)
void	setDiscard (const std::string &discard)
void	setCreate (const std::string &type, const std::string &name, const std::string &value)
Protected Attributes
std::string	oldName
	the old name of the attribute to be renamed
std::string	newName
	the new name of the attribute to be renamed
std::string	discard
	the name of the attribute to be discarded
std::string	type
	the type of the attribute to be created
std::string	name
	the name of the attribute to be created
std::string	value
	the value of the attribute to be created
Friends
class	CommonNodeFactory

---

Member Function Documentation

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

Returns 1 to show that this node is an event generator. Returns: 1 because node implements EventGenerator Reimplemented from ot::Node.

void ot::EventUtilityNode::onEventGenerated (  Event &  event, Node &  generator )  [virtual]

This method changes the incoming event and updates the node's observers. Parameters: event  the incoming event generator  the node that generated the incoming event Reimplemented from ot::Node.

void ot::EventUtilityNode::setCreate (  const std::string &  type, const std::string &  name, const std::string &  value )

Sets the type, name, and value (encoded in strings) of the attribute, which is to be created. Parameters: type  generic type name of the new attribute name  the name of the new attribute value  the initial value of the new attribute Returns:

void ot::EventUtilityNode::setDiscard (  const std::string &  discard  )

Sets the name of the attribute, which is to be discarded. Parameters: discard  name of the attribute to be discarded

void ot::EventUtilityNode::setRename (  const std::string &  oldName, const std::string &  newName )

Sets the old and new name of the attribute, which is to be renamed. Parameters: oldName  the old name newName  the new name

---

Friends And Related Function Documentation

friend class CommonNodeFactory [friend]

---

Member Data Documentation

std::string ot::EventUtilityNode::discard [protected]

the name of the attribute to be discarded

std::string ot::EventUtilityNode::name [protected]

the name of the attribute to be created Reimplemented from ot::Node.

std::string ot::EventUtilityNode::newName [protected]

the new name of the attribute to be renamed

std::string ot::EventUtilityNode::oldName [protected]

the old name of the attribute to be renamed

std::string ot::EventUtilityNode::type [protected]

the type of the attribute to be created Reimplemented from ot::Node.

std::string ot::EventUtilityNode::value [protected]

the value of the attribute to be created

---

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

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

---