ot::RDSModule Class Reference

#include <RDSModule.h>

Inheritance diagram for ot::RDSModule:

[legend]Collaboration diagram for ot::RDSModule:

[legend]List of all members.

Public Member Functions
	RDSModule ()
virtual	~RDSModule ()
virtual void	init (StringTable &attributes, ConfigNode *localTree)
virtual Node *	createNode (const std::string &name, StringTable &attributes)
virtual void	start ()
virtual void	close ()
virtual void	pushEvent ()
void	onEventGenerated (Event &event, Node &generator)
Protected Member Functions
int	connect ()
void	run ()
Protected Attributes
int	stop
ACE_INET_Addr	address
ACE_SOCK_Stream	socket
ACE_SOCK_Connector	connector
NodeVector	sources
NodeVector	sinks
Friends
class	RDSSource

---

Constructor & Destructor Documentation

ot::RDSModule::RDSModule (   )

basic constructor

ot::RDSModule::~RDSModule (   )  [virtual]

destructor

---

Member Function Documentation

void ot::RDSModule::close (   )  [virtual]

closes the module and closes any communication sockets and stops thread. Reimplemented from ot::ThreadModule.

int ot::RDSModule::connect (   )  [protected]

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

This method is called to construct a new Node. It compares name to the EndoscoutSource element name, and if it matches creates a new EndoscoutSource node. Parameters: name  reference to string containing element name refenrence to StringTable containing attribute values Returns: pointer to new Node or NULL. Implements ot::NodeFactory.

void ot::RDSModule::init (  StringTable &  attributes, ConfigNode *  localTree )  [virtual]

initializes the Endoscout module. Parameters: attributes  refenrence to StringTable containing attribute values localTree  pointer to root of configuration nodes tree Reimplemented from ot::Module.

void ot::RDSModule::onEventGenerated (  Event &  event, Node &  generator )

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

pushes event information into the tree. It checks whether there is new data for any EndoscoutSource node, copies it into the nodes and calls push on them. Reimplemented from ot::Module.

void ot::RDSModule::run (   )  [protected, virtual]

the work method for the module thread. This is executed by the new module thread. In this class it does nothing but subclasses should override it to add their implementation. Reimplemented from ot::ThreadModule.

void ot::RDSModule::start (   )  [virtual]

starts the receive thread. It is called after initialisation is done. Reimplemented from ot::ThreadModule.

---

Friends And Related Function Documentation

friend class RDSSource [friend]

---

Member Data Documentation

ACE_INET_Addr ot::RDSModule::address [protected]

ACE_SOCK_Connector ot::RDSModule::connector [protected]

NodeVector ot::RDSModule::sinks [protected]

ACE_SOCK_Stream ot::RDSModule::socket [protected]

NodeVector ot::RDSModule::sources [protected]

int ot::RDSModule::stop [protected]

---

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

• include/OpenTracker/input/RDSModule.h
• src/input/RDSModule.cxx

---