NaviTrack Tutorial:Creating module:Module structure - Revision history

Tokuda at 23:16, 15 May 2007

2007-05-15T23:16:16Z

Tokuda at 23:14, 15 May 2007

2007-05-15T23:14:47Z

Tokuda: /* Module class */

2007-05-15T23:11:14Z

Module class

Tokuda: /* Sink class */

2007-05-15T23:00:12Z

Sink class

Tokuda: /* createNode() */

2007-05-15T22:59:49Z

createNode()

Tokuda at 22:58, 15 May 2007

2007-05-15T22:58:27Z

Tokuda: /* init() */

2007-05-15T22:57:37Z

init()

Tokuda at 22:05, 15 May 2007

2007-05-15T22:05:06Z

Tokuda: /* Classes for module "MyTutorialThreadModule" (w/ thread) */

2007-05-15T22:01:20Z

Classes for module "MyTutorialThreadModule" (w/ thread)

Tokuda: /* Classes for module "MyTutorialModule" (w/o thread) */

2007-05-15T22:00:40Z

Classes for module "MyTutorialModule" (w/o thread)

@@ Line 173: / Line 173: @@
 === isEventGenerator() ===
 This is same as isEventGenerator() in Sink class.
 Go back to [[NaviTrack_Tutorial:Creating_module|Creating module]].

← Older revision		Revision as of 23:14, 15 May 2007
Line 1:		Line 1:
−	~~= Three types of nodes =~~
−
−	~~===Sink nodes (XxxxSink.h, [XxxxSink.cxx])===~~
−	~~Leaves in the graph and receive their data values from external sources, such as Polaris optraciking system, and send put the data into NaviTrack data flow graph.~~
−
−	~~===Source nodes (XxxxSource.h, [XxxxSource.cxx])===~~
−	~~Leaves to propagate their data values received from other nodes to external outputs.~~
−
−	~~===Filter nodes (we don't use this in the tutorial)===~~
−	~~Intermediate nodes and modify the values received from other nodes.~~
−
−
−	~~= Two types of Modules =~~
−
−	~~===Normal module===~~
−	~~Each node of modules has event handling functions to put, pull and process data,~~
−	~~and these are called whenever corresponding events occure.~~
−	~~Therefore, the timing of processing is detemined only by NaviTrack events.~~
−
−	~~===Thread module===~~
−	~~In some application, a module has to call certain procedures~~
−	~~with its own timing, e.g. monitoring hardware, acquiring data from a device.~~
−	~~For this purpose, NaviTrack allows us to create a module with~~
−	~~threading capability. The structure of thread module will be~~
−	~~described later.~~
−
	= Classes for normal module =		= Classes for normal module =
	== Module class ==		== Module class ==

← Older revision		Revision as of 23:11, 15 May 2007
Line 206:		Line 206:

	MyTutorialThreadModule.h		MyTutorialThreadModule.h
		+	#ifndef __MY_TUTORIAL_THREAD_MODULE_H__
		+	#define __MY_TUTORIAL_THREAD_MODULE_H__
		+
		+	#include <OpenTracker/OpenTracker.h>
		+	#include <OpenTracker/dllinclude.h>
		+	#include <OpenTracker/input/SPLModules.h>
		+	#include <OpenTracker/input/MyTutorialThreadSink.h>
		+	#include <OpenTracker/input/MyTutorialThreadSource.h>
		+	#include <string>
		+
		+	namespace ot {
		+
		+	class OPENTRACKER_API MyTutorialThreadModule : public ThreadModule, public NodeFactory
		+	{
		+	private:
		+	int stop;
		+
		+	protected:
		+	void run();
		+
		+	public:
		+
		+	// Constructor and destructor
		+	MyTutorialThreadModule();
		+	virtual ~MyTutorialThreadModule();
		+
		+	Node* createNode(const std::string& name, ot::StringTable& attributes);
		+	void pushEvent();
		+	void pullEvent() {};
		+	void init(StringTable&, ConfigNode *);
		+
		+	virtual void start();
		+	virtual void close();
		+
		+	private:
		+
		+	MyTutorialThreadSink* sink;
		+	MyTutorialThreadSource* source;
		+
		+	friend class MyTutorialThreadSink;
		+	friend class MyTutorialThreadSource;
		+	};
		+	OT_MODULE(MyTutorialThreadModule);
		+
		+
		+	} // end of namespace ot
		+
		+	#endif // __MY_TUTORIAL_THREAD_MODULE_H__
		+
		+	The differences from MyTutorialModule.h is :
		+	# MyTutorialThreadModule inherits ThreadModule instead of Module class.
		+	# init(): ThreadModule::init() needs to be called in init() for threading.
		+	# run(): a main part of the thread.
		+	# start(): a function to start the thread.
		+	# close(): a function to stop the thread.

		+
		+	=== init() ===
		+	void MyTutorialThreadModule::init(StringTable& attributes, ConfigNode * localTree)
		+	{
		+	std::cout << "MyTutorialThreadModule::init() is called." << std::endl;
		+	ThreadModule::init( attributes, localTree );
		+
		+	std::string strName=attributes.get("name");
		+	std::cout << "MyTutorialThreadModule::init(): attribute \"name\" is "
		+	<< strName << std::endl;
		+	}
		+
		+	=== run() ===
		+	void MyTutorialThreadModule::run()
		+	{
		+	std::cout << "MyTutorialThreadModule::run() is called." << std::endl;
		+	while (stop == 0) {
		+	sleep(1);
		+	std::cout << "MyTutorialThreadModule::run(): looping." << std::endl;
		+	}
		+	}
		+
		+	=== start() ===
		+	void MyTutorialThreadModule::start()
		+	{
		+	std::cout << "MyTutorialThreadModule::start() is called." << std::endl;
		+	stop = 0;
		+	if (isInitialized() && source != NULL)
		+	ThreadModule::start();
		+	}
		+	NOTE that start() function may be called even if the module is not
		+	specified in the configuration XML file.
		+	Therefore, you should explicitly check if the module is used before
		+	calling ThreadModule::start().
		+
		+
		+	=== close() ===
		+	void MyTutorialThreadModule::close()
		+	{
		+	std::cout << "MyTutorialThreadModule::close() is called." << std::endl;
		+	lock();
		+	stop = 1;
		+	unlock();
		+	}

	== Sink class ==		== Sink class ==

@@ Line 154: / Line 154: @@
   } // end of namespace ot
-−
-#endif // end of __MY_TUTORIAL_SINK_H
+ #endif // end of __MY_TUTORIAL_SINK_H
 === isEventGenerator() ===

@@ Line 98: / Line 98: @@
     if( name.compare("MyTutorialSink") == 0 )
+      {
         sink =  new MyTutorialSink();
         return sink;
@@ Line 103: / Line 106: @@
     if(name.compare("MyTutorialSource") == 0 )
+      {
-        std::string name=attributes.get("name");
+        std::string strName=attributes.get("name");
-        source = new MyTutorialSource();
+       std::cout << "MyTutorialModule::createNode(): creating a MyTutorialSource node" << std::endl;
         return source;
+      }

@@ Line 115: / Line 115: @@
 You can get any parameters specified for a certain node in XML configuration file,
-by using ot::StringTable::get() function, as shown in above code.
+by calling attribute.get(<parameter name>) function, as shown in above code.
 === pushEvent() and pullEvent() ===

@@ Line 77: / Line 77: @@
 of the XML file, during starting up.
 You can put codes to initialize the module into this function.
 === createNode() ===

@@ Line 13: / Line 13: @@
 = Two types of Modules =
-===Normal Module===
+===Normal module===
 Each node of modules has event handling functions to put, pull and process data,
 and these are called whenever corresponding events occure.
 Therefore, the timing of processing is detemined only by NaviTrack events.
-===Thread Module===
+===Thread module===
 In some application, a module has to call certain procedures
 with its own timing, e.g. monitoring hardware, acquiring data from a device.
@@ Line 25: / Line 25: @@
 described later.
-= Classes for module "MyTutorialModule" (w/o thread) =
+= Classes for normal module =
 == Module class ==
@@ Line 184: / Line 184: @@
 This is same as isEventGenerator() in Sink class.
-= Classes for module "MyTutorialThreadModule" (w/ thread) =
+= Classes for thread module =
 == Module class ==
 In a thread module, the only difference from a normal module

@@ Line 185: / Line 185: @@
 = Classes for module "MyTutorialThreadModule" (w/ thread) =
-== Module class (MyTutorialThreadModule.h, MyTutorialThreadModule.cxx) ==
+== Module class ==
 In a thread module, the only difference from a normal module
 is a module class, where a thread is implemented.
@@ Line 192: / Line 192: @@
-== Sink class (MyTutorialThreadSink.h, MyTutorialThreadSink.cxx) ==
+== Sink class ==
 Same as MyTutorialSink.
-== Source class (MyTutorialThreadSource.h, MyTutorialThreadSource.cxx) ==
+== Source class ==
 Same as MyTutorialSource.
 Go back to [[NaviTrack_Tutorial:Creating_module|Creating module]].

@@ Line 26: / Line 26: @@
 = Classes for module "MyTutorialModule" (w/o thread) =
-== Module class (MyTutorialModule.h, MyTutorialModule.cxx) ==
+== Module class ==
 This class is used to configure and manage source and sink nodes.
@@ Line 110: / Line 110: @@
 These are called whenever a push or pull event occurs.
-== Sink class (MyTutorialSink.h, MyTutorialSink.cxx) ==
+== Sink class ==
 This class is for a Sink node itself.
@@ Line 149: / Line 149: @@
 This is an event handler for generated event.
-== Source class (MyTutorialSource.h, MyTutorialSource.cxx) ==
+== Source class ==
 This class is a Source node itself. The following example class contains only essential functions for a Source node.
@@ Line 183: / Line 183: @@
 === isEventGenerator() ===
 This is same as isEventGenerator() in Sink class.
 = Classes for module "MyTutorialThreadModule" (w/ thread) =