An Open Architecture for Reconfigurable Tracking based on XML | Contact

ot::Module Class Reference

#include <Module.h>

Inheritance diagram for ot::Module:

Inheritance graph
Collaboration diagram for ot::Module:

Collaboration graph
List of all members.

Public Member Functions

 Module ()
virtual ~Module ()
virtual void close ()
virtual void init (StringTable &attributes, ConfigNode *localTree)
virtual void pullEvent ()
virtual void pushEvent ()
virtual void start ()
virtual int stop ()
int isInitialized ()

Protected Attributes

int initialized


class Context

Detailed Description

Definition at line 68 of file Module.h.

Constructor & Destructor Documentation

ot::Module::Module (  )  [inline]

constructor method

Definition at line 82 of file Module.h.

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

virtual destructor (as it befits any true class hierarchy)

Definition at line 85 of file Module.h.

Member Function Documentation

virtual void ot::Module::init ( StringTable attributes,
ConfigNode localTree 
) [inline, virtual]

initializes the tracker module.

This class provides an implementation that sets the initialization flag to true. Subclasses should call this method, if they override it, before doing anything else. It takes the attributes of the element configuring this module and a local tree consisting of the children of the element. This tree must be build of Nodes.

attributes StringTable of elements attribute values. Should be possibly , but is not for convenience.
localTree pointer to root of configuration nodes tree

Reimplemented in ot::ConsoleModule, ot::FileModule, ot::LogModule, ot::TimeModule, ot::ARTDataTrackerModule, ot::ARToolKitModule, ot::ARToolKitPlusModule, ot::DynaSightModule, ot::FastTrakModule, ot::FOBModule, ot::GPSModule, ot::InterSenseModule, ot::LinmouseModule, ot::MagicYModule, ot::MulticastInputModule, ot::OpenVideoModule, ot::P5GloveModule, ot::SpeechModule, ot::UbisenseModule, ot::UltraTrakModule, ot::CORBAModule, ot::DwarfModule, ot::NetworkSinkModule, ot::TCPModule, ot::VRPNModule, ot::QtMouseEventModule, and ot::QtMouseEventModuleBase.

Definition at line 103 of file Module.h.

Referenced by ot::VRPNModule::init(), ot::UltraTrakModule::init(), ot::TimeModule::init(), ot::TCPModule::init(), ot::SpeechModule::init(), ot::QtMouseEventModuleBase::init(), ot::P5GloveModule::init(), ot::OpenVideoModule::init(), ot::NetworkSinkModule::init(), ot::MulticastInputModule::init(), ot::MagicYModule::init(), ot::LogModule::init(), ot::InterSenseModule::init(), ot::GPSModule::init(), ot::FOBModule::init(), ot::FileModule::init(), ot::FastTrakModule::init(), ot::DynaSightModule::init(), ot::DwarfModule::init(), ot::CORBAModule::init(), ot::ARTDataTrackerModule::init(), ot::ConfigurationParser::parseConfigurationFile(), and ot::SpaceMouseModule::run().

virtual void ot::Module::pullEvent (  )  [inline, virtual]

pulls event information out of the tracker tree.

It enables the module to query any EventQueue or TimeDependend node in the shared memory. It is called after pushEvent was executed on each module.

Reimplemented in ot::ConsoleModule, ot::DwarfModule, ot::NetworkSinkModule, ot::TCPModule, ot::VRPNModule, ot::QtMouseEventModule, and ot::QtMouseEventModuleBase.

Definition at line 113 of file Module.h.

Friends And Related Function Documentation

friend class Context [friend]

Definition at line 142 of file Module.h.

Member Data Documentation

pointer to the context this module is working in.

It will be set by the initialize method.

Reimplemented in ot::OpenVideoModule.

Definition at line 77 of file Module.h.

Referenced by ot::Context::addModule(), ot::FileModule::createNode(), ot::ARToolKitPlusModule::createNode(), and ot::ARToolKitPlusModule::init().

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

copyright (c) 2006 Graz University of Technology