SPEL+ Language Reference
This section describes each SPEL+ command as follows:
- Syntax
- The syntax defines the format to use the command. For some commands, there is more than one syntax shown, along with a number that is referenced in the command description. Parameters are shown in italics.
The following symbols are used in the syntax:
Symbol: [ ]
Indicates an optional parameter.
These square brackets are used in the following patterns:
When parameters are separated by blank spaces
When parameters are separated by blank spaces, the order of the parameters can be changed and/or any of them can be omitted.When parameters are separated by commas
When parameters are separated by commas, the order of parameters cannot be changed.
All of the parameters following the last comma can be omitted, while those before the last comma cannot be omitted.
Example:
Inertia [loadInertia [, eccentricity]]
In this example:
Inertia [loadInertia] is allowed.
Inertia is allowed.
Inertia [, eccentricity] is not allowed.
Symbol: { }
Indicates that one of the provided parameters can be selected.
Any of the parameters separated by | can be selected.Example:
Exit { Do | For | Function }
In this example, select Do, For, or Function. - Parameters
- Describes each of the parameters for the command.
- Result
- Describes values that the command returns.
- Return value
- Describes values that the function returns.
- Description
- Gives details about how the command works.
- Note
- Gives additional information that may be important about this command.
- See also
- Lists other commands that are related to this command. Refer to the Table of Contents for the page number of the related commands.
- Example
- Gives one or more examples of using the command.