Overview of configuration parameters (ACS)
Configuration Parameters are advanced features that can configure and control ACS.
Configuration Parameters can control standard features of ACS, such as, whether generation is enabled or not. Some Configuration Parameters provide functionality that is not available through the ACS user interface, such as, prefixing log entries with the date and time, and forcing ACS to preserve text within markers in generated code files.
Configuration Parameters can be defined in the following way:
Use the registry to set up Configuration Parameters that you always want to apply by default on your computer.
 |
If you set a Configuration Parameter in the registry and you are using both ACS and TDK, the Configuration Parameter may affect both ACS and TDK.
|
Use Configuration Parameter Files to set up the same Configuration Parameters for multiple users.
• Through a Generation Settings Scheme.
Use a Generation Settings Scheme when you want to override Configuration Parameters that have been set through the registry or through a Configuration Parameter File.
|
|
When you specify a configuration parameter in the Launch ACS/TDK dialog, you must prefix the configuration parameter with a -, for example, -Log_Time.
|
When a Configuration Parameter has a value:
• The value can be initially set in the registry.
• The value set in the registry can be overridden by a value set in a Configuration Parameter File (.par).
• The value set in a Configuration Parameter File (.par) can be overridden by a value set through the Generation Settings Scheme.
You can use = or : to delimit the Configuration Parameter from its value. A value can optionally be enclosed within straight quotation marks. The straight quotation marks are automatically removed when the Configuration Parameter is parsed, so that they are not part of the value taken into account by the system. For example:
Log_App="c:\My Logs\My Log.txt"
When a Configuration Parameter that does not have a value has been set, it can be unset only through the ResetAllParams configuration parameter.
In addition to the provided configuration parameters, you can create your own Configuration ParameterS and interrogate them in SDL script. In the following example, the Launch Options in the Generation Settings Scheme creates a configuration parameter named MYOPTION:
-MYOPTION="some string here"
In the SDL script, the MYOPTION configuration parameter can be interrogated through a block of C++ code.
%cpp
if (TShadowPaths::HasParam ("MYOPTION")) {
TStr ParamValue = TShadowPaths::getParam ("MYOPTION");
/// user code here
}
%endcpp
if (TShadowPaths::HasParam ("MYOPTION")) {
TStr ParamValue = TShadowPaths::getParam ("MYOPTION");
/// user code here
}
%endcpp
The following Configuration Parameter are provided for use with ACS.
•
CodeToModelTransferDisabled – disables the reversing of text within markers from code files.
•
ComDirRoot - specifies the absolute path of a folder in which the ComDir subfolder is created for storing the model SHM files.
•
EmulateOCS – reduces the time taken to generate code for ACS Code Generator DLLs that have been created from migrated OCS Generation Template Schemes.
•
EnableFileBackup – makes ACS back up code files when the code file has more marked text than the file that is going to replace it.
•
EnablePreserveTaggedText - ensures that text within markers in the code files is not overwritten.
•
FileBackupFolder - specifies the name of the folder that is used to back up files when using the EnableFileBackup configuration parameter.
•
FlagsSettingDisabled – Makes selected buttons and check boxes read-only only
•
GenerateDefaultObjsEnabled – selects or clears the Generate Default Named Items check box on the ACS/TDK Settings dialog.
•
GenerateEnabled - disables or enables the Enable or Code Generation button on the ACS/TDK Control tab.
•
GenerateOnStartupEnabled - selects or clears the Generate on Startup check box on the ACS/TDK Settings dialog.
•
Log_Time - specifies that each line of the ACS log is prefixed by the date and time it was written.
•
MultiRoot - specifies that ACS is started in MultiRoot mode, which allows multiple root items to be selected in the model.
•
ParamFile – references and uses a Configuration Parameter File from a Configuration Parameter File.
•
PerUser - specifies whether the ACS ComDir folder is created in the Documents and Settings\All Users folder or the Documents and Settings\<user> folder.
•
ReverseEnabled - disables or enables the Enable or Disable Reverse Engineering button on the ACS/TDK Control tab.
•
ReverseOnStartupEnabled - selects or clears the Reverse on Startup check box on the ACS/TDK Settings dialog.
•
SuppressReadonlyError - prevents ACS from reporting errors to the ACS Log pane that are the result of generating to or reverse engineering from read-only files.