Previous Next        Current Page: NeXtMidas User's Guide / System Operation / Parameters
back
- FAQs   
- Release Information   
- Getting Help   
+ Basic Concepts   
+ Result Parameters   
- JSON Support   
- XML Support   
+ Files   
- System Operation   
   - Basic Command Form   
   - Parameters   
      - Positional Parameters   
      - Keyword Parameters   
   + Switches   
   + Metacharacters   
   - Inline Calculations   
   - Function Invocation   
+ Macros   
+ Java WebStart   
+ Graphics   
+ X-Midas Interoperability   
+ Third-Party Compatibility   
+ Build/Installation Options and Customization   
- Running NeXtMidas Independently   
- WebVNC to deploy NeXtMidas as a Web App   
+ Security and Secure Communication   
- Timelines - Keywords, Updating, Known Issues   
+ Installing and Using Docker   
+ Glossary   


Parameters

Parameters specify the arguments required by the command. The format of a command line is:

nM><command> <parameter1> ... <parameterN>

Commas or blanks separate arguments from each other and from the command name. Parameter names are identified and given default values in the NeXtMidas command dictionary; if listed in the dictionary, the parameter name may be abbreviated. To see the arguments for a particular command, use EXPLAIN. Below is an annotated example of the explanation for RAMP. It shows that the RAMP command has 8 arguments indicated within the <angle brackets>:

nM> explain ramp
RAMP  creates a ramp (sawtooth) file
 
<OUT>       Nameof output file
<FORM>      Formatof output file (SF< CF<SB< etc.)
<ELEM>      Numberof elements in output file
<DATASTART> Ordinatevalue for first point in file
<DATAINC>   Ordinatedifference between consecutive points in file
<START>     Abscissastart
<DELTA>     Abscissadelta
<UNITS>     Abscissaunits

To see the defaults of a command, type DEFAULT before the command name. The example below shows the defaults for RAMP:

nM> default ramp
INFO:RMP;SYS:2,P,8,OUT=,FORM=SF,ELEM-4K,DATASTART=0,
DATAINC=1,START=0,DELTA=1,UNITS=1
nM>

There are two types of parameters: Positional and Keyword.


back