Toni: moved Programmer Guide/Class Library/ADesc - Parameter Description Classes to Programmer Guide/Macro Library/ADesc

2011-04-28T07:50:00Z

moved Programmer Guide/Class Library/ADesc - Parameter Description Classes to Programmer Guide/Macro Library/ADesc

← Older revision	Revision as of 09:50, 28 April 2011
(No difference)

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T15:54:49Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 17:54, 5 April 2011
Line 12:		Line 12:
	<code>ADesc</code> - is the general class. It handles everything the other classes don't handle, but it does so at a high price indeed.		<code>ADesc</code> - is the general class. It handles everything the other classes don't handle, but it does so at a high price indeed.

	<code>ADescX</code> - is functionally equivalent to <code>ADesc</code>. It organizes the data in a different way and currently proves more performance than <code>ADesc</code>. This may change as table handling in ~~S_TOOLS-STx~~ changes over time.		<code>ADescX</code> - is functionally equivalent to <code>ADesc</code>. It organizes the data in a different way and currently proves more performance than <code>ADesc</code>. This may change as table handling in {{STX}} changes over time.

	When creating a new parameter, you will have to specify which one to create. You may do so either by calling the static "New" function of the ADesc class of your choice, e.g. "ADesc2 new" for creating an ADesc2 instance.		When creating a new parameter, you will have to specify which one to create. You may do so either by calling the static "New" function of the ADesc class of your choice, e.g. "ADesc2 new" for creating an ADesc2 instance.
Line 49:		Line 49:
	====ABaseClass : CObj====		====ABaseClass : CObj====

	<code>ABaseClass</code> is the base class of all kinds of <code>ADesc</code> classes. Its sole purpose is providing for configurable logging functions. Depending on which of the following variables are set to <code>1</code> or to <code>0</code>, messages are logged in different ways. These logging methods are not mutually exclusive. Therefore it is e.g. possible to show error messages both in the ~~S_TOOLS-STx~~ log and in dialog boxes (which, by chance, is the default behaviour).		<code>ABaseClass</code> is the base class of all kinds of <code>ADesc</code> classes. Its sole purpose is providing for configurable logging functions. Depending on which of the following variables are set to <code>1</code> or to <code>0</code>, messages are logged in different ways. These logging methods are not mutually exclusive. Therefore it is e.g. possible to show error messages both in the {{STX}} log and in dialog boxes (which, by chance, is the default behaviour).

	<code>ABaseClass</code> modifies the shell variables <code>aDescError</code> and <code>aDescLogOpts</code>. See <code>aDescError</code> and <code>aDescLogOpts</code> for details.		<code>ABaseClass</code> modifies the shell variables <code>aDescError</code> and <code>aDescLogOpts</code>. See <code>aDescError</code> and <code>aDescLogOpts</code> for details.
Line 63:		Line 63:
	<code>aDescLogOpts = log con box</code>		<code>aDescLogOpts = log con box</code>

	If <code>log</code> is set to <code>1</code>, messages are displayed in the ~~S_TOOLS-STx~~ log-window. If <code>con</code> is set to <code>1</code>, messages are displayed in the BScript console (if object CON exists). If <code>box</code> is set to <code>1</code>, messages are displayed in a message box.		If <code>log</code> is set to <code>1</code>, messages are displayed in the {{STX}} log-window. If <code>con</code> is set to <code>1</code>, messages are displayed in the BScript console (if object CON exists). If <code>box</code> is set to <code>1</code>, messages are displayed in a message box.

	=====ABaseClass Member Functions=====		=====ABaseClass Member Functions=====
Line 2,430:		Line 2,430:
	===GetReservedAttributes===		===GetReservedAttributes===

	Returns a blank separated list of attributes which are reserved by ~~S_TOOLS-STx~~.		Returns a blank separated list of attributes which are reserved by {{STX}}.

	===CheckReservedAttribute===		===CheckReservedAttribute===
Line 2,528:		Line 2,528:
	Create a new parameter instance derived from <code>ADesc</code>. The exact type is chosen automatically using the function <code>GetBestClassForAxes</code>.		Create a new parameter instance derived from <code>ADesc</code>. The exact type is chosen automatically using the function <code>GetBestClassForAxes</code>.

	The keywords "<code>BINARY</code>" and "<code>XML</code>" specify how to store the data. <code>XML</code> means that they are being stored inplace in the ~~S_TOOLS-STx~~ XML DataSet (like the old <code>APar</code> class), <code>BINARY</code> means that they are stored in an external binary file. By default, the file name used for this file is generated automatically, and the file is placed in the ~~S_TOOLS-STx~~ directory, "<code>$@root</code>". You may change the name and location of this binary file by calling <code>setStorage</code> and supplying this function with the desired file name.		The keywords "<code>BINARY</code>" and "<code>XML</code>" specify how to store the data. <code>XML</code> means that they are being stored inplace in the {{STX}} XML DataSet (like the old <code>APar</code> class), <code>BINARY</code> means that they are stored in an external binary file. By default, the file name used for this file is generated automatically, and the file is placed in the {{STX}} directory, "<code>$@root</code>". You may change the name and location of this binary file by calling <code>setStorage</code> and supplying this function with the desired file name.

	=====Usage:=====		=====Usage:=====
Line 2,619:		Line 2,619:
	===SimpleExtNew===		===SimpleExtNew===

	The keywords "BINARY" and "XML" specify how to store the data. XML means that they are being stored inplace in the ~~S_TOOLS-STx~~ XML DataSet(like the old <code>APar</code> class), BINARY means that they are stored in an external binary file. By default, the filename used for this file is generated automatically, and the file is placed in the ~~S_TOOLS-STx~~ directory, "<code>$@root</code>". You may change the name and location of this binary file by calling "<code>setStorage</code>" and supplying this function with the desired filename.		The keywords "BINARY" and "XML" specify how to store the data. XML means that they are being stored inplace in the {{STX}} XML DataSet(like the old <code>APar</code> class), BINARY means that they are stored in an external binary file. By default, the filename used for this file is generated automatically, and the file is placed in the {{STX}} directory, "<code>$@root</code>". You may change the name and location of this binary file by calling "<code>setStorage</code>" and supplying this function with the desired filename.

	=====Usage:=====		=====Usage:=====

Admin: 1 revision: Initial import

2010-11-18T16:31:31Z

1 revision: Initial import

← Older revision		Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

Show changes

Programmer Guide/Macro Library/ADesc - Revision history

Toni: moved Programmer Guide/Class Library/ADesc - Parameter Description Classes to Programmer Guide/Macro Library/ADesc

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

Admin: 1 revision: Initial import

193.171.195.8: initial import