Replay - Revision history

Jca: /* How to use */

2011-09-17T06:51:38Z

How to use

← Older revision		Revision as of 08:51, 17 September 2011
Line 46:		Line 46:
	>> myplugin replay=true		>> myplugin replay=true
	>> myplugin step=1		>> myplugin step=1

			===Handle command options===

	So add something like this to your on-line help part of handleCommand method:		So add something like this to your on-line help part of handleCommand method:
Line 62:		Line 64:
	...		...
	bool valueBool;		bool valueBool;
	if (msg->tag.getAttBool("replay", &valueBool, true)		if (msg->tag.getAttBool("replay", &valueBool, true))
	setReplay(valueBool);		setReplay(valueBool);
	// replay ~~ste~~		// replay step
	int valueInt;		int valueInt;
	if (msg->tag.getAttInteger("step", &valueInt, 1))		if (msg->tag.getAttInteger("step", &valueInt, 1))
Line 70:		Line 72:

	The setReplay(bool) and replayStep(int) is already available in the plug-in and resource classes.		The setReplay(bool) and replayStep(int) is already available in the plug-in and resource classes.

			===handle replay lines===

	The replay system will call ''decodeReplayLine(char * line)'' whenever it is time to replay a new line of data.		The replay system will call ''decodeReplayLine(char * line)'' whenever it is time to replay a new line of data.
Line 84:		Line 88:
	sensorUpdate(t, x, y, z);		sensorUpdate(t, x, y, z);
	}		}

			===Replay logfile name and path===

	The replay must know the name of the replay file. This filename should be a reserved name for this plug-in, preferred the same name as the plug-in, with a ''.log'' extension.		The replay must know the name of the replay file. This filename should be a reserved name for this plug-in, preferred the same name as the plug-in, with a ''.log'' extension.
Line 97:		Line 103:
	server replayPath="/home/myname/replayLogs/20110618/"		server replayPath="/home/myname/replayLogs/20110618/"
	...		...

			===Replay status===

			If you want replay status (replay mode, replay line and replay time) as part of the global variables, then
			call createReplayVar(UVarPool * vp) when the remaining global variables are created.

			createReplayVar(getVarPool());

			To test if the plug-in is in replay mode a function isReplay() is available.

			isReplay();

			===Replay synchronize with other servers===

	If the server is to synchronize the replay with other servers, then the servers must be connected with interface plug-ins. E.g. if the camera server ''ucamserver'' is to replay in sync with the laser scanner server ''ulmsserver'', then set up an interface connection between them, and set this interface in replay mode.		If the server is to synchronize the replay with other servers, then the servers must be connected with interface plug-ins. E.g. if the camera server ''ucamserver'' is to replay in sync with the laser scanner server ''ulmsserver'', then set up an interface connection between them, and set this interface in replay mode.

Jca at 07:03, 17 July 2011

2011-07-17T07:03:16Z

← Older revision		Revision as of 09:03, 17 July 2011
Line 37:		Line 37:

	The other plug-ins then advance until the next replay line has a timestamp that is ahead of this replay time. All the lines up to this time (zero or many) will be send to the plug-in - in a ''decodeReplayLine(..)'' call.		The other plug-ins then advance until the next replay line has a timestamp that is ahead of this replay time. All the lines up to this time (zero or many) will be send to the plug-in - in a ''decodeReplayLine(..)'' call.

			Check the on-line help of plug-ins to see if they support replay.

	==How to use==		==How to use==
Line 83:		Line 85:
	}		}

	The replay must know the name of the replay file. This filename should be a reserved name for this ~~plugin~~, preferred the same name as the ~~plugin~~, with a ''.log'' extension.		The replay must know the name of the replay file. This filename should be a reserved name for this plug-in, preferred the same name as the plug-in, with a ''.log'' extension.
	Set this filename in the plug-in constructor:		Set this filename in the plug-in constructor:

Line 96:		Line 98:
	...		...

	If the server is to synchronize the replay with other servers, then the servers must be connected with interface ~~plugins~~. E.g. if the camera server ''ucamserver'' is to replay in sync with the laser scanner server ''ulmsserver'', then set up an interface connection between them, and set this interface in replay mode.		If the server is to synchronize the replay with other servers, then the servers must be connected with interface plug-ins. E.g. if the camera server ''ucamserver'' is to replay in sync with the laser scanner server ''ulmsserver'', then set up an interface connection between them, and set this interface in replay mode.
	The ''.ini'' file should include something like:		The ''.ini'' file should include something like:

Line 114:		Line 116:
	cam replay		cam replay
	..		..

	~~Check the on-line help of plugins to see if they support replay.~~

Jca at 07:02, 17 July 2011

2011-07-17T07:02:10Z

← Older revision		Revision as of 09:02, 17 July 2011
Line 115:		Line 115:
	..		..

	~~==How it works==~~		Check the on-line help of plugins to see if they support replay.

	~~todo~~

Jca: /* How to use */

2011-07-17T06:59:52Z

How to use

@@ Line 95: / Line 95: @@
   server replayPath="/home/myname/replayLogs/20110618/"
   ...
 ==How it works==
 todo

Jca: /* How to use */

2011-07-17T06:50:22Z

How to use

← Older revision		Revision as of 08:50, 17 July 2011
Line 88:		Line 88:
	...		...
	replaySetBaseFileName("myplugin");		replaySetBaseFileName("myplugin");
			...

			The ''.log'' extension is added, and the file must be present in the ''replayPath''. This ''replayPath'' should be set in the ''.ini'' file of the server, e.g.:

			...
			server replayPath="/home/myname/replayLogs/20110618/"
	...		...

Jca: /* How to use */

2011-07-17T06:46:42Z

How to use

← Older revision		Revision as of 08:46, 17 July 2011
Line 69:		Line 69:
	The setReplay(bool) and replayStep(int) is already available in the plug-in and resource classes.		The setReplay(bool) and replayStep(int) is already available in the plug-in and resource classes.

	The replay system will call ''decodeReplayLine(char * line)'' whenever it is time to replay a new line of data~~, triggered by a step command in this plugin or a step in any other plugin in replay mode, and the time passed exceeds the timestamp in this replay file~~.		The replay system will call ''decodeReplayLine(char * line)'' whenever it is time to replay a new line of data.

	So define a method to handle the decode of line to replay, this could look something like:		So define a method to handle the decode of line to replay, this could look something like:

Line 83:		Line 82:
	sensorUpdate(t, x, y, z);		sensorUpdate(t, x, y, z);
	}		}

			The replay must know the name of the replay file. This filename should be a reserved name for this plugin, preferred the same name as the plugin, with a ''.log'' extension.
			Set this filename in the plug-in constructor:

			...
			replaySetBaseFileName("myplugin");
			...

	==How it works==		==How it works==

	todo		todo

Jca: /* Replay mode */

2011-07-17T06:36:18Z

Replay mode

← Older revision		Revision as of 08:36, 17 July 2011
Line 32:		Line 32:
	The interface can then be stepped (one or more lines at a time)		The interface can then be stepped (one or more lines at a time)

	The ~~plugin~~ will then insert the data (typically as it came from the interface)		The plug-in will then insert the data (typically as if it came from the interface)

			All plug-in modules are connected, so that if one plug-in module is stepped one line. The replay time (the first element in any replay line) is advanced and all other plug-ins in replay mode are requested to advance to this time.

			The other plug-ins then advance until the next replay line has a timestamp that is ahead of this replay time. All the lines up to this time (zero or many) will be send to the plug-in - in a ''decodeReplayLine(..)'' call.

	==How to use==		==How to use==

Jca: /* How to use */

2011-07-17T06:27:52Z

How to use

← Older revision		Revision as of 08:27, 17 July 2011
Line 41:		Line 41:
	>> myplugin step=1		>> myplugin step=1

	So add something like this to your on-line help part:		So add something like this to your on-line help part of handleCommand method:

			bool myclass::handleCommand(UServerInMsg * msg, void * extra)
			...
	sendHelpStart( ...		sendHelpStart( ...
	...		...
	sendText("replay=true\|false Start or stop replay mode for this plug-in);		sendText("replay=true\|false Start or stop replay mode for this plug-in\n");
	sendText("step = N replay N steps from replay file\n");		sendText("step = N replay N steps from replay file\n");
	...		...
	sendHelpDone();		sendHelpDone();

	And to handle these options, something like:		And to handle these options in the same function, something like:

			...
	bool valueBool;		bool valueBool;
	if (msg->tag.getAttBool("replay", &valueBool, true)		if (msg->tag.getAttBool("replay", &valueBool, true)
Line 61:		Line 64:

	The setReplay(bool) and replayStep(int) is already available in the plug-in and resource classes.		The setReplay(bool) and replayStep(int) is already available in the plug-in and resource classes.

			The replay system will call ''decodeReplayLine(char * line)'' whenever it is time to replay a new line of data, triggered by a step command in this plugin or a step in any other plugin in replay mode, and the time passed exceeds the timestamp in this replay file.

			So define a method to handle the decode of line to replay, this could look something like:

			virtual bool decodeReplayLine(char * line)
			{
			unsigned long int sec, usec;
			double x, y, z;
			UTime t;
			int n = sscanf(line, "%lu.%lu x y z", &sec, &usec, &x, &y, &z);
			// fake a sensor update, as if it came from the sensor itself
			t.setTimeU(sec, usec);
			sensorUpdate(t, x, y, z);
			}

	==How it works==		==How it works==

	todo		todo

Jca: /* How to use */

2011-07-17T06:09:15Z

How to use

@@ Line 36: / Line 36: @@
 ==How to use==
-todo
+To make a plugin with replay, you must handle two keywords options in the plugin.
 ==How it works==
 todo

Jca: /* Replay File format */

2011-07-17T05:26:53Z

Replay File format

← Older revision		Revision as of 07:26, 17 July 2011
Line 19:		Line 19:
	1299310466.028311 0.07 0.08 3.1		1299310466.028311 0.07 0.08 3.1
	1299310466.052313 0.05 0.04 3.1		1299310466.052313 0.05 0.04 3.1
	~~1299310466.068308 0.05 0.03 3.11~~		# crc-check error in communication with sensor
	1299310466.088313 0.07 0.05 3.12		1299310466.088313 0.07 0.05 3.12