Previous Next        Current Page: NeXtMidas User's Guide / Basic Concepts / Option Trees / Command Dictionary
back
FAQs   
Release Information   
Getting Help   
Basic Concepts   
   - Summary of Capabilities   
   + System Overview   
   + Shell   
   - Option Trees   
      - Option Tree Structure   
      - Command Dictionary   
      - Factory-Supported Option Trees   
   + Commands   
Result Parameters   
XML Support   
Files   
System Operation   
Macros   
Java WebStart   
Graphics   
X-Midas Interoperability   
Third-Party Compatibility   
Installation and Customization   
Running NeXtMidas Independently   
Timelines - Keywords, Updating, Known Issues   
WebSwing to deploy NeXtMidas as a Web App   
Glossary   
Installing and Using Docker   
Using Gradle To Build NextMidas   
NeXtMidas Support for Continous Integrations with GitLab   


Dictionary

Every option tree must include a dictionary named commands.cnf in its cfg subdirectory. The dictionary specifies the following attributes for each command provided by the option tree:

  • Command name, including optional abbreviation point
  • Type of command (intrinsic, primitive, or macro)
  • Number of command parameters
  • Parameter names (optional)
  • Parameter default values (optional)

A command definition occupies a single line in the dictionary. A sample dictionary entry looks like this:

MYC*OMMAND P, 3+, INPUT=, ITERATIONS=1K, 0

This fictitious entry demonstrates all of the commonly encountered variations:

  • The full command name is MYCOMMAND, which can be shortened to MYC. (You cannot give multiple commands in one option tree the same full or abbreviated command name, but identically named commands in different option trees is acceptable.)
  • The command is a primitive.
  • The command accepts 3 or more parameters.
  • The first parameter is named INPUT and has no default value.
  • The second parameter is named ITERATIONS and has a default value of 1024. NeXtMidas recognizes the 'K' and 'M' suffixes and assigns to them their customary binary values.
  • The third parameter is not named, but 0 is its default value.
  • All other parameters are neither named nor defaulted.

back