The Simulator Identification dialog can be obtained by the following:
Creating a new Schema Definition to enter the Simulator Identification from scratch, or
Using the Action>Change Identification pull-down menu to edit the Simulator Identification in an existing Schema Definition.
The Simulator Identification contains an icon for the simulator, the name and options of the simulator, the documentation file name and its location, as well as your company and workgroup names.
It is the icon to be used for program identity. In the SansGUI environment, all icons contain both large (32x32) and small (16x16) size icons used in various occasions. You can create an icon file with an .ico extension by using any icon editor. It is recommended that you use the icon editor in Visual Studio that comes with Microsoft Visual C++ or Compaq Visual Fortran. There are some basic icons in the img subdirectory of the SansGUI installation directory for you to work with. You can also extract icons from an executable program (.exe) or a dynamic linked library (.dll). Before extracting the icon, however, please be sure that you do not infringe its creator's copyright.
To select an icon, click on the Change Icon button next to the icon and use the Open dialog to locate the desired icon file. Click on the Open button to commit the selection and you will see the icon in the Simulator Identification dialog being updated.
Under the Name tab in the grid area of the Simulator Identification dialog, the following fields are listed:
Program (required): the name of the simulator. It is strongly recommended that the name is the same as the name of the Schema Definition file without the .sgs extension because it will be used to generate Object Library files and to locate simulators. A consistent name throughout will simplify file maintenance. The syntax of the name string follows the identifiers rules in the GUI Control Data Representation section of the SansGUI Reference Manual except that the first character can be an alphabet letter, a digit or a hyphen, similar to those of parts and links.
Description (optional): a short description of the simulator. A little bit more descriptive than the simulator name itself.
Document File (optional): the document file name of the simulator. It can be of any type provided the user has a compatible reader that can identify the document file type via the file extension. This field does not require any enclosing characters < > as opposed to the requirement in the SansGUI Run-Time Environment. If you type in a file name without the directory path, the default directory will be used. You may use a relative directory to put all your documentation in a subdirectory with a unique name. Suppose the default document directory is in C:\SansGUI\v1.0\doc and you have created a mySim directory under the doc directory. Your document file may be specified as mySim\index.htm.
Company (optional): the name of the company that creates the simulator or the copyright owner of the simulator. This field is essential if you would like to take advantage of SansGUI's class sharing capability. The first three characters and the length of the string will be used as a portion of the unique identifiers of the classes created within.
Group (optional): the workgroup in the company that the simulator belongs to. Similar to the Company field, the first three characters and the length of the string will be used as a portion of the unique identifiers of the classes created within.
Password (optional): the password to be used to enter a service session. Some of the features, such as locking or unlocking an object, suppressing or revealing the import mask of imported classes, and showing hidden attributes, are designed to be accessible only by developers. The password simply let you identify yourself as the developer of the simulator.
In the Option tab in the grid area of the Simulator Identification dialog, there is a table for entering simulator options. There are 32 options, indicating a maximum of 32 capabilities, definable by the simulation developer. With certain options defined, the developer can then assign compatibility options in each class so that some option (such as a Deluxe Version) may contain more classes than others (such as a Standard Version). The positions (or indices) of these options are very important because SansGUI internally uses bit pattern matching to check compatibility. In other words, both the code and the description fields are informational, not the key field. You have to be careful when you modify the options in your subsequent software releases. If you reuse a position for a different option in a later version, the classes that are compatible with an older and, perhaps obsolete, option that occupied the same position become compatible with the newer option. Therefore, it is a good idea to append a new entry to the end of the options and reuse a position only when you are sure that no one uses the old option in any current Project Models.
When you have multiple options defined, SansGUI will generate an Object Library per each option with the file name appended with the option code entered here. You can ship the Object Library with the proper option code to correspond to the particular level your user has licensed.
After you have entered the above information, click on the OK button to create an empty Schema Definition with only intrinsic classes. The new Schema Definition will be opened in a window with a generic name such as SGscm1.sgs. It is suggested that you save the newly created Schema Definition in a file right away and use the simulator's program name as the name of the file. Use File>Save, File>Save As or click on the Save button in the File toolbar to obtain the Save As dialog to save it.
SansGUI Modeling and Simulation Environment Version 1.2
Copyright © 2000-2003 ProtoDesign, Inc. All rights reserved.