Plug-in structure - Revision history

Jca: /* Global variables and inter-plug-in calls */

2010-04-25T14:17:16Z

Global variables and inter-plug-in calls

← Older revision		Revision as of 16:17, 25 April 2010
Line 179:		Line 179:
	See [[Variables]].		See [[Variables]].

	The calls has an alternative implementation that takes UVariable as parameter (for both strings, doubles and arrays) this makes calls ~~sompler~~ in some cases.		The inter-plug-in calls has an alternative implementation that takes UVariable as parameter (for both strings, doubles and arrays) this makes calls simpler in some cases.

	@todo describe the call implementation using UVariable parameters.		@todo describe the call implementation using UVariable parameters.

Jca: /* Global variables and inter-plug-in calls */

2010-04-25T14:16:05Z

Global variables and inter-plug-in calls

← Older revision		Revision as of 16:16, 25 April 2010
Line 177:		Line 177:
	== Global variables and inter-plug-in calls ==		== Global variables and inter-plug-in calls ==

	See ~~also~~ [[Variables]]		See [[Variables]].

			The calls has an alternative implementation that takes UVariable as parameter (for both strings, doubles and arrays) this makes calls sompler in some cases.

			@todo describe the call implementation using UVariable parameters.

	== Laser scanner access ==		== Laser scanner access ==

Jca: /* Method implementation */

2010-04-25T14:10:05Z

Method implementation

← Older revision		Revision as of 16:10, 25 April 2010
Line 72:		Line 72:
	23 sendText("--- MINIMUM is a demonstration plug-in that calculates the minimum of two numbers\n");		23 sendText("--- MINIMUM is a demonstration plug-in that calculates the minimum of two numbers\n");
	24 sendText("a=A Value of A (default is 100)\n");		24 sendText("a=A Value of A (default is 100)\n");
	25 sendText("a=B Value of B (default is 100)\n");		25 sendText("b=B Value of B (default is 100)\n");
	26 sendText("help This message\n");		26 sendText("help This message\n");
	27 sendHelpDone();		27 sendHelpDone();
Line 104:		Line 104:
	--- MINIMUM is a demonstration plug-in that calculates the minimum of two numbers		--- MINIMUM is a demonstration plug-in that calculates the minimum of two numbers
	a=A Value of A (default is 100)		a=A Value of A (default is 100)
	a=B Value of B (default is 100)		b=B Value of B (default is 100)
	help This message		help This message
	</help>		</help>

Jca: /* Method implementation */

2010-04-25T14:09:19Z

Method implementation

← Older revision		Revision as of 16:09, 25 April 2010
Line 70:		Line 70:
	21 { // create the reply in XML-like (html - like) format		21 { // create the reply in XML-like (html - like) format
	22 sendHelpStart("MINIMUM");		22 sendHelpStart("MINIMUM");
	23 sendText("--- MINIMUM is a demonstration ~~plugin~~ that calculates the minimum of two numbers\n");		23 sendText("--- MINIMUM is a demonstration plug-in that calculates the minimum of two numbers\n");
	24 sendText("a=A Value of A (default is 100)\n");		24 sendText("a=A Value of A (default is 100)\n");
	25 sendText("a=B Value of B (default is 100)\n");		25 sendText("a=B Value of B (default is 100)\n");
Line 100:		Line 100:
	The reply must be packed in the XML format, and this code makes a reply to a ''minimum help'' command:		The reply must be packed in the XML format, and this code makes a reply to a ''minimum help'' command:

			>> minimum help
	<help subject="MINIMUM">		<help subject="MINIMUM">
	--- MINIMUM is a demonstration ~~plugin~~ that calculates the minimum of two numbers		--- MINIMUM is a demonstration plug-in that calculates the minimum of two numbers
	a=A Value of A (default is 100)		a=A Value of A (default is 100)
	a=B Value of B (default is 100)		a=B Value of B (default is 100)

Jca: /* Method implementation */

2010-04-25T14:07:11Z

Method implementation

← Older revision		Revision as of 16:07, 25 April 2010
Line 86:		Line 86:
	* The first line is to include the class definition.		* The first line is to include the class definition.

	* The lines 2-7 defines the function the server ~~uses~~ to create an instance of the UFuncMinimum plug-in class.		* The lines 2-7 defines the function the server calls to create an instance of the ''UFuncMinimum'' plug-in class.

	The rest (line 16-35) is a simple command handling method, with a recommendable structure:		The rest (line 16-35) is a simple command handling method, with a recommendable structure:

Jca: /* Class definition */

2010-04-25T14:05:07Z

Class definition

← Older revision		Revision as of 16:05, 25 April 2010
Line 37:		Line 37:

	The class enherits all the needed core functionality from ''UFuncPlugBase''.		The class enherits all the needed core functionality from ''UFuncPlugBase''.
	The plugin ~~has a~~ key-name ~~called~~ ''minimum'' ~~as defined~~ in the class constructor.		The plugin gets the command key-name ''minimum'' from the ''setCommand(..)'' call in the class constructor.

	When the server gets a command with the keyword ''minimum'' it ~~callse~~ the function		When the server gets a command with the keyword ''minimum'' it calls the function
	bool handleCommand(UServerInMsg * msg, void * extra);		bool handleCommand(UServerInMsg * msg, void * extra);
	This function has two parameters, the command message itself in ''msg'' and an ''extra'' parameter used in		This function has two parameters, the command message itself in ''msg'' and an ''extra'' parameter used in

Jca: /* Makefile */

2010-04-25T10:55:12Z

Makefile

@@ Line 141: / Line 141: @@
 The Makefile gives the name of the plug-in and must know which files to compile.
-@todo which lines
+  libname = minimum.so
 == Global variables and inter-plug-in calls ==

Jca: /* Method implementation */

2010-04-25T10:45:52Z

Method implementation

← Older revision		Revision as of 12:45, 25 April 2010
Line 134:		Line 134:

	In the last example the command is packed as an XML formatted tag, but in the used tag interpreter, the requirement for the tag frame ''< .../>'' and the quotes or apostrophes around the values are relaxed. Quotes or apostrophes are mandatory if the value includes a space character.		In the last example the command is packed as an XML formatted tag, but in the used tag interpreter, the requirement for the tag frame ''< .../>'' and the quotes or apostrophes around the values are relaxed. Quotes or apostrophes are mandatory if the value includes a space character.

			* line 34 returns true (can return false if the number of calls are important and this command failed, e.g. if no source image is available right now. Number of successful calls can be used in push commands.

	=== Makefile ===		=== Makefile ===

Jca: /* Method implementation */

2010-04-25T10:42:23Z

Method implementation

← Older revision		Revision as of 12:42, 25 April 2010
Line 84:		Line 84:
	35 }		35 }

	The first line is to include the class definition.		* The first line is to include the class definition.

	The lines 2-7 defines the function the server uses to create an instance of the UFuncMinimum plug-in class.		* The lines 2-7 defines the function the server uses to create an instance of the UFuncMinimum plug-in class.

	The rest is a simple command handling method, with a ~~recomendable~~ structure:		The rest (line 16-35) is a simple command handling method, with a recommendable structure:

	* Line 16-18 retrives the options from the command line		* Line 16-18 retrives the options from the command line
Line 133:		Line 133:
	The commands and attribute names are not case sensitive.		The commands and attribute names are not case sensitive.

	In the last example the command is packed as an XML formatted tag, but in the used tag interpreter, the requirement for the tag frame ''< .../>'' and the quotes or apostrophes around the values are relaxed. Quotes or apostrophes are mandatory if the value includes a space character.		In the last example the command is packed as an XML formatted tag, but in the used tag interpreter, the requirement for the tag frame ''< .../>'' and the quotes or apostrophes around the values are relaxed. Quotes or apostrophes are mandatory if the value includes a space character.

	=== Makefile ===		=== Makefile ===

Jca: /* Minimum plugin */

2010-04-25T10:40:48Z

Minimum plugin

← Older revision		Revision as of 12:40, 25 April 2010
Line 84:		Line 84:
	35 }		35 }

			The first line is to include the class definition.

			The lines 2-7 defines the function the server uses to create an instance of the UFuncMinimum plug-in class.

			The rest is a simple command handling method, with a recomendable structure:

			* Line 16-18 retrives the options from the command line

			The ''msg->tag.getAttValue("help", const char * val, const int valCnt)'' in line 16 uses the 'tag' structure in the message 'msg'. The tag structure holds the original XML formatted command, and has a few methods to extract values. The basic is to get the value string 'val' (of size valCnt) associated with an attribute. (The tag is an instance of the class ''USmlTagIn'', see the class documentation for the full API)

			Line 17 and 18 uses a specialized method (bool tag.getAttDouble("a", &a, a)) to get a double sized value from an attribute named "a". The second parameter is where the value is placed and the third parameter is the default value, used if the value string is empty. (The function returns false if an attribute with this name is not available).

			* Line 20-28 is the on-line help reply.

			The reply must be packed in the XML format, and this code makes a reply to a ''minimum help'' command:

			<help subject="MINIMUM">
			--- MINIMUM is a demonstration plugin that calculates the minimum of two numbers
			a=A Value of A (default is 100)
			a=B Value of B (default is 100)
			help This message
			</help>
			<minimum info="done"/>

			The help text is packed in <help> ... </help> bracket marking that this is intended for on-line help (and not for computer interpretation.

			The last tag <minimum info="done"> is to satisfy a handshake that there should always be a reply of the same tag name as the command (in this case ''minimum''). This handshake convension is not mandatory, but provides an indication of that the command is executed.

			* line 29-33 is where the real functionality of the plug-in is executed and the replay assembled.

			When following is examples on commands and the reply from the ''minimum'' plug-in:

			>> minimum
			<minimum info="minimum(a=100, b=100) is 100"/>
			>>
			>> minimum A=9 B=8.99
			<minimum info="minimum(a=9, b=8.99) is 8.99"/>
			>>
			>> minimum b=8.2
			<minimum info="minimum(a=100, b=8.2) is 8.2"/>
			>>
			>> minimum b=8.2 a=8.3
			<minimum info="minimum(a=8.3, b=8.2) is 8.2"/>
			>>
			>> <minimum b="8.2" a='8.3'/>
			<minimum info="minimum(a=8.3, b=8.2) is 8.2"/>

			The commands and attribute names are not case sensitive.

			In the last example the command is packed as an XML formatted tag, but in the used tag interpreter, the requirement for the tag frame ''< .../>'' and the quotes or apostrophes around the values are relaxed. Quotes or apostrophes are mandatory if the value includes a space character.

	=== Makefile ===		=== Makefile ===