Programmer Guide/Macro Library/CObjEx - Revision history

Toni: /* LogTimer */

2018-03-07T12:05:47Z

LogTimer

← Older revision		Revision as of 14:05, 7 March 2018
Line 56:		Line 56:

	===LogTimer===		===LogTimer===
	;<code><var>~~inst~~</var> logtimer <var>cmd ; text</var></code>:		;<code><var>cobjex_inst</var> logtimer <var>cmd ; text</var></code>:
	:;<var>cmd</var>: one of the following:		:;<var>cmd</var>: one of the following:
	::*<code>ON</code> or <code>BEGIN</code>: start the timer and/or display the elapsed time the console window.		::*<code>ON</code> or <code>BEGIN</code>: start the timer and/or display the elapsed time the console window.

Toni: /* LogTimer */

2018-03-07T12:05:14Z

LogTimer

← Older revision		Revision as of 14:05, 7 March 2018
Line 60:		Line 60:
	::*<code>ON</code> or <code>BEGIN</code>: start the timer and/or display the elapsed time the console window.		::*<code>ON</code> or <code>BEGIN</code>: start the timer and/or display the elapsed time the console window.
	::*<code>OFF</code> or <code>END</code>: stop the timer and display the elapsed time in the console window.		::*<code>OFF</code> or <code>END</code>: stop the timer and display the elapsed time in the console window.
			:;<var>text</var>: the text to write to the console window
	;Return: The elapsed time in seconds.		;Return: The elapsed time in seconds.
	;Description: Start (continue) or stop the internal timer of the object and write the elapsed time and <var>text</var> to the console window.		;Description: Start (continue) or stop the internal timer of the object and write the elapsed time and <var>text</var> to the console window.

Toni at 12:04, 7 March 2018

2018-03-07T12:04:39Z

← Older revision		Revision as of 14:04, 7 March 2018
Line 46:		Line 46:
	:;<var>text</var>: the text to write to the script console.		:;<var>text</var>: the text to write to the script console.
	;Result: none		;Result: none
	;Description: Write the message <code><var>cobjex_inst</var>: Error! - <var>text</var></code> to the script console and exits the specified number of macro levels (<code>exit <var>lev</var> set '<var>res</var>').		;Description: Write the message <code><var>cobjex_inst</var>: Error! - <var>text</var></code> to the script console and exits the specified number of macro levels (<code>exit <var>lev</var> set '<var>res</var>'</code>).

	===LogExit===		===LogExit===

Toni: /* Rules for derived classes */

2018-03-07T12:03:54Z

Rules for derived classes

← Older revision		Revision as of 14:03, 7 March 2018
Line 23:		Line 23:
	:The default constructor calls the CObj constructor and writes a construct-message to the console window. The base class member takes no arguments and returns always 0 (success). It must be called by derived classes.		:The default constructor calls the CObj constructor and writes a construct-message to the console window. The base class member takes no arguments and returns always 0 (success). It must be called by derived classes.

	'''~~public_detsruct~~:'''		'''public_destruct:'''
	:The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.		:The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.

Toni: /* Rules for derived classes */

2018-03-07T12:03:44Z

Rules for derived classes

← Older revision		Revision as of 14:03, 7 March 2018
Line 20:		Line 20:
	If a derived class implementa a '''construct''' or '''destruct''' member, the base class member must be called.		If a derived class implementa a '''construct''' or '''destruct''' member, the base class member must be called.

	;public_construct:		'''public_construct:'''
	:The default constructor calls the CObj constructor and writes a construct-message to the console window. The ~~function~~ takes no arguments and returns always 0 (success). It must be called by derived classes.		:The default constructor calls the CObj constructor and writes a construct-message to the console window. The base class member takes no arguments and returns always 0 (success). It must be called by derived classes.

	;public_detsruct:		'''public_detsruct:'''
	:The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.		:The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.

Toni at 12:02, 7 March 2018

2018-03-07T12:02:47Z

← Older revision		Revision as of 14:02, 7 March 2018
Line 34:		Line 34:
	;Description:Delete all instances of classes derived from <code>CObjEx</code>. This function is called automatically by the script controller (<code>BScript</code>) before the script application exits.		;Description:Delete all instances of classes derived from <code>CObjEx</code>. This function is called automatically by the script controller (<code>BScript</code>) before the script application exits.

	====Log====		===Log===
	;Usage:<code><var>cobjex_inst</var> log <var>text</var></code>:		;Usage:<code><var>cobjex_inst</var> log <var>text</var></code>:
	:;<var>text</var>: ~~The~~ text to write to the script console.		:;<var>text</var>: the text to write to the script console
	;Result: none		;Result: none
	;Description: Write the message <code><var>cobjex_inst</var>: <var>text</var></code> to the script console.		;Description: Write the message <code><var>cobjex_inst</var>: <var>text</var></code> to the script console.

	====ELog====		===ELog===
	;Usage:<code><var>cobjex_inst</var> elog <var>lev ; res ; text</var></code>		;Usage:<code><var>cobjex_inst</var> elog <var>lev ; res ; text</var></code>
	:;<var>lev</var>: the number of macro levels to close ('''1''' = return to caller, '''2''' = exit caller, ...; default=2)		:;<var>lev</var>: the number of macro levels to close ('''1''' = return to caller, '''2''' = exit caller, ...; default=2)
	:;<var>res</var>: the result value to be returned; no default (empty)		:;<var>res</var>: the result value to be returned; no default (empty)
	:;<var>text</var>: ~~The~~ text to write to the script console.		:;<var>text</var>: the text to write to the script console.
	;Result: none		;Result: none
	;Description: Write the message <code><var>cobjex_inst</var>: Error! - <var>text</var></code> to the script console and exits the specified number of macro levels (<code>exit <var>lev</var> set '<var>res</var>').		;Description: Write the message <code><var>cobjex_inst</var>: Error! - <var>text</var></code> to the script console and exits the specified number of macro levels (<code>exit <var>lev</var> set '<var>res</var>').


	===LogExit===		===LogExit===
	~~'''public'''~~		;Usage: <code><var>cobjex_inst</var> logexit <var>res ; text</var></code>:
			:;<var>res</var>: the result to assign after returning.
	;<code><var>~~cobjex~~</var> ~~logError~~ <var>~~result</var>~~; ~~<var>~~text</var></code>:		:;<var>text</var>: the text to write to the console window
	:;<var>~~result~~</var>: ~~The~~ result to assign after returning.		;Result: The value of argument <var>res</var>
	:;<var>text</var>: ~~The~~ text to write to the console window.		;Description: Writes the message <code>class-instance: <var>text</var></code> to the script console and exits from 2 macros (= return from caller) with the return value <var>res</var>.
	;Result: The value of argument <var>~~result~~</var>
	;Description: Writes the message <code>class-instance: <var>text</var></code> to the script console and exits from 2 macros (= return from caller) with the return value <var>~~result</var>.~~

	~~===LogExt===~~
	~~'''public'''~~

	~~;<code><var>inst</var> LogExt <var>mode</var> ; <var>text~~</var>~~</code>:~~
	~~:;<var>mode</var>: If <code>0</code>, the text overwrites the last log window line. If <code>1</code>, the text is appended to the last log window line.~~
	~~:;<var>text</var>: The text to write to the log window.~~
	~~;Result: none~~
	~~;Description: Write text to the <code>CON</code> log window with the option of overwriting the last line. This is useful for progress reports~~.

	===LogTimer===		===LogTimer===
	~~'''public'''~~		;<code><var>inst</var> logtimer <var>cmd ; text</var></code>:
			:;<var>cmd</var>: one of the following:
	;<code><var>inst</var> ~~LogTimer~~ <var>cmd</var></code>:		::*<code>ON</code> or <code>BEGIN</code>: start the timer and/or display the elapsed time the console window.
	:;<var>cmd</var>: ~~One~~ of the following:		::*<code>OFF</code> or <code>END</code>: stop the timer and display the elapsed time in the console window.
	::*<code>ON</code> or <code>BEGIN</code>: ~~Start~~ the timer and/or display the elapsed time the console window.
	::*<code>OFF</code> or <code>END</code>: ~~Stop~~ the timer and display the elapsed time in the console window.
	;Return: The elapsed time in seconds.		;Return: The elapsed time in seconds.
	;Description: Start (continue) or stop the internal timer of the object and write the elapsed time ~~to console window (using [[#Log\|Log]]).~~		;Description: Start (continue) or stop the internal timer of the object and write the elapsed time and <var>text</var> to the console window.

	~~====ELog====~~
	~~;<code><var>cobjex</var> ELog <var>level</var> ; <var>result</var> ; <var>text</var></code>:~~
	~~:;<var>level</var>: The number of macro levels to return (<code>2</code> means: return from calling-macro).~~
	~~:;<var>result</var>: The result to set on returning.~~
	:;<var>text</var>~~: The text to write~~ to the console window.
	~~;Result: The value of the argument <var>result</var>. Note: This value is returned to macro addressed by argument <var>level</var>.~~
	~~;Description: Writes the message <code>class-instance: ERROR - <var>text</var></code> to the script console and exits from <var>level</var> macros with the return value <var>result</var>~~.

Toni: /* Rules for derived classes */

2018-03-07T11:56:47Z

Rules for derived classes

← Older revision		Revision as of 13:56, 7 March 2018
Line 20:		Line 20:
	If a derived class implementa a '''construct''' or '''destruct''' member, the base class member must be called.		If a derived class implementa a '''construct''' or '''destruct''' member, the base class member must be called.

	;~~Constructor~~: The default constructor calls the CObj constructor and writes a construct-message to the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.		;public_construct:
			:The default constructor calls the CObj constructor and writes a construct-message to the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.

	;~~Destructor~~: The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.		;public_detsruct:
			:The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.

	==Member Functions==		==Member Functions==

Toni: /* Rules for derived classes */

2018-03-07T11:55:43Z

Rules for derived classes

← Older revision		Revision as of 13:55, 7 March 2018
Line 18:		Line 18:

	==Rules for derived classes==		==Rules for derived classes==
			If a derived class implementa a '''construct''' or '''destruct''' member, the base class member must be called.

	;Constructor: The default constructor calls the CObj constructor and writes a construct-message to the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.		;Constructor: The default constructor calls the CObj constructor and writes a construct-message to the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.

Toni at 11:54, 7 March 2018

2018-03-07T11:54:13Z

← Older revision		Revision as of 13:54, 7 March 2018
Line 17:		Line 17:
	</pre>		</pre>

			==Rules for derived classes==

	;Constructor: The default constructor calls the CObj constructor and writes a construct-message to the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.		;Constructor: The default constructor calls the CObj constructor and writes a construct-message to the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.

	;Destructor: The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj ~~constructor~~ and writes a destruct-message to the console window. It must be called by derived classes.		;Destructor: The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj destructor and writes a destruct-message to the console window. It must be called by derived classes.

	;Member ~~functions: [[#Cleanup\|Cleanup (static)]], [[#Log\|Log]], [[#LogExit\|LogExit]], [[#LogExt\|LogExt]], [[#LogTimer\|LogTimer]], [[#ELog\|ELog]]~~		==Member Functions==

	===Cleanup===		===Cleanup (static)===
	~~'''static'''~~

	;<code>~~CObjEx Cleanup~~</code>		;<code>cobjex cleanup</code>
	;Result: none:		;Result: none:
	;Description:Delete all instances of classes ~~based on~~ <code>CObjEx</code>. This function is called automatically by the script ~~processor~~ (<code>BScript</code>) before the script application exits.		;Description:Delete all instances of classes derived from <code>CObjEx</code>. This function is called automatically by the script controller (<code>BScript</code>) before the script application exits.

	====Log====		====Log====
	~~'''public'''~~		;Usage:<code><var>cobjex_inst</var> log <var>text</var></code>:
			:;<var>text</var>: The text to write to the script console.
			;Result: none
			;Description: Write the message <code><var>cobjex_inst</var>: <var>text</var></code> to the script console.

	;<code><var>~~cobjex~~</var> ~~log~~ <var>text</var></code>:		====ELog====
	:;<var>text</var>: The text to write to the ~~log window~~.		;Usage:<code><var>cobjex_inst</var> elog <var>lev ; res ; text</var></code>
			:;<var>lev</var>: the number of macro levels to close ('''1''' = return to caller, '''2''' = exit caller, ...; default=2)
			:;<var>res</var>: the result value to be returned; no default (empty)
			:;<var>text</var>: The text to write to the script console.
	;Result: none		;Result: none
	;Description: Write the message <code>~~class~~-~~instance:~~ <var>text</var></code> to the script console.		;Description: Write the message <code><var>cobjex_inst</var>: Error! - <var>text</var></code> to the script console and exits the specified number of macro levels (<code>exit <var>lev</var> set '<var>res</var>').


	===LogExit===		===LogExit===

Toni at 11:42, 7 March 2018

2018-03-07T11:42:45Z

← Older revision		Revision as of 13:42, 7 March 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}~~__NOTOC__~~		{{DISPLAYTITLE:{{SUBPAGENAME}} - Base class for objects used in script applications}}
	*'''File''': CLASSES.STX, linked to library STX.LIB		*'''File''': CLASSES.STX, linked to library STX.LIB
	*'''Title''': Base class for objects used in script applications		*'''Parent''': [[Programmer_Guide/Macro_Library/COBJ\|CObj]], '''Derived classes''': [[Programmer_Guide/Macro_Library/XPlot\|XPlot]], [[Programmer_Guide/Macro_Library/XGraph\|XGraph]], [[Programmer_Guide/Macro_Library/XWave\|XWave]]
	*'''Parent''': [[Programmer_Guide/Macro_Library/CObj~~\|COBJ~~]], '''Derived classes''': [[Programmer_Guide/Macro_Library/XPlot\|XPlot]], [[Programmer_Guide/Macro_Library/XGraph\|XGraph]], [[Programmer_Guide/Macro_Library/XWave\|XWave]]

	The class <code>CObjEx</code> is an enhanced base class designed for objects which are used in {{STX}} scripts. Objects based on this class are deleted automatically before the script application is finished. By convention a class based on <code>CObjEx</code> implements the following simple instantiation method:		The class <code>CObjEx</code> is an enhanced base class designed for objects which are used in {{STX}} scripts. Objects based on this class are deleted automatically before the script application is finished. By convention a class based on <code>CObjEx</code> implements the following simple instantiation method:
	::<code> <var>~~cobjex~~</var> := <var>cobjExClassName</var> <var>constructionArguments</var> </code>
	::* <~~var~~>cobjex</~~var~~> ~~is the name of the created instance~~		::<code> <var>cobjexinst</var> := <var>cobjExClassName</var> <var>constructionArguments</var> </code>

			This instantation method can simply be implemented:

			<pre>
			[class myclassex cobjex]
			exit 1 set '$(cobj 'new $#mac $#argv')'

			// start with member functions here
			...
			</pre>