public class MfOptions extends Model<MfOptions>
MfGui
. MfOptions()
.
Model.parse(String[],MessageReceiver,String)
has_[X]()
. get_[X]_[n]()
. get_[X]_[n](k)
. If anything went wrong in parsing, errors
have been sent to the MessageReceiver
.
Then further analysis methods can be applied (Model.getParsingProtocol()
, Model.getMissingOptions()
, Model.usage()
, etc.)
For further details. please see the
documentation of the methods inherited from the superclass Model
and the option
compiler's user documentation.
Here is the source text.
The usage()
method will show this screen:
====== USAGE: ====== -v / --version (bool)?(=true iff present) show version number -d / --debuglevel int(=0) 0-100 for minimal to maximal debug verbosity -0 / --inputfile uri(="") text file in tscore format to process -1 / --outputfile uri(="") output text file in svg format -u / --userCoords int(=20) int(=20) int(=70) int(=70) sequence of four integer numbers as user coordinate limis. First lower x and lower y, than upper x and upper y. The lower values will be mapped to the physical output coordinate zero(0). The higher will be mapped to the coordinates given by the option --physCoords. Please note that in physical coordinates (aka device coordinates) the y axis grows downwards. -p / --physCoords int(=800) int(=800) physUnit(=px) sequence of two integer numbers, x width and y height of the physical output, and the unit in which they are measured. The coordinates start at the upper left corner of the output area with zero comma zero (0,0). --timeFactor float(=1.0) factor for multiplying the duration values. Iff this is 1.0, then the numeric values give real-time seconds. -i / --interactive (bool)?(=true iff present) flag whether to open the gui to edit parameters physUnit = (px | pt | pc | mm | cm | in | em | ex)
Modifier and Type | Class and Description |
---|---|
class |
MfOptions.Descriptions
Programmatically generated catalog of translations.
|
static class |
MfOptions.physUnit
Source generated from a command line options specification.
|
Model.ExcDuplicate, Model.ExcEndOfRepet, Model.ExcNoData, Model.ExcNoData_allowed, Model.ExcSkipReachesEnd, Model.ExcUnknownOpt, Model.ExcWrongType, Model.Pre20220613, Model.SeemsToWorkForLinuxAndSomeWindowsVersions20220613
Modifier and Type | Field and Description |
---|---|
protected boolean |
has_debuglevel |
protected boolean |
has_inputfile |
protected boolean |
has_interactive |
protected boolean |
has_outputfile |
protected boolean |
has_physCoords |
protected boolean |
has_timeFactor |
protected boolean |
has_userCoords |
protected boolean |
has_version |
protected int |
value_debuglevel_0 |
protected String |
value_inputfile_0 |
protected boolean |
value_interactive_0 |
protected String |
value_outputfile_0 |
protected int |
value_physCoords_0 |
protected int |
value_physCoords_1 |
protected MfOptions.physUnit |
value_physCoords_2 |
protected double |
value_timeFactor_0 |
protected int |
value_userCoords_0 |
protected int |
value_userCoords_1 |
protected int |
value_userCoords_2 |
protected int |
value_userCoords_3 |
protected boolean |
value_version_0 |
curArg, curArgGroup, curOption, currentErrorPos, descriptions, dummyRat, hasNonMetaOptions, inputlength, inputstring, matcher, messages, msg, nextToken, optionDirector, p_rest, positionalPhase, positionalsExplicit, positionalsFound, protocol, shellAdapter
Constructor and Description |
---|
MfOptions() |
Modifier and Type | Method and Description |
---|---|
protected void |
_finalCheck()
Callback, overridden by compiled code.
|
String |
_getMissingOptions()
Is overridden in the generated code and concatenates the "longest names"
of all otions marked as required, but not present in the parsed input.
|
String |
_getRedundantOptions()
Callback, overridden by compiled code.
|
protected void |
checkActive()
The generated code will evaluate all conditions to activate/deactive
options in the GUI.
|
int |
get_debuglevel_0()
Getter method for the only argument of option
debuglevel . |
String |
get_inputfile_0()
Getter method for the only argument of option
inputfile . |
boolean |
get_interactive_0()
Getter method for the only argument of option
interactive . |
String |
get_outputfile_0()
Getter method for the only argument of option
outputfile . |
int |
get_physCoords_0()
Getter method for the 0th argument of option
physCoords . |
int |
get_physCoords_1()
Getter method for the 1st argument of option
physCoords . |
MfOptions.physUnit |
get_physCoords_2()
Getter method for the 2nd argument of option
physCoords . |
double |
get_timeFactor_0()
Getter method for the only argument of option
timeFactor . |
int |
get_userCoords_0()
Getter method for the 0th argument of option
userCoords . |
int |
get_userCoords_1()
Getter method for the 1st argument of option
userCoords . |
int |
get_userCoords_2()
Getter method for the 2nd argument of option
userCoords . |
int |
get_userCoords_3()
Getter method for the 3rd argument of option
userCoords . |
boolean |
get_version_0()
Getter method for the 0th argument of option
version . |
boolean |
has_debuglevel()
Deprecated.
|
boolean |
has_inputfile()
Deprecated.
|
boolean |
has_interactive()
Deprecated.
|
boolean |
has_outputfile()
Deprecated.
|
boolean |
has_physCoords()
Deprecated.
|
boolean |
has_timeFactor()
Deprecated.
|
boolean |
has_userCoords()
Deprecated.
|
boolean |
has_version()
Deprecated.
|
MfOptions |
makeDefaultInstance()
Overriden by the generated code to make a constructor call of the actual
Model (sub-)class.
|
protected int |
numberOfPositionals()
The generated code will return the number of positional parameters.
|
protected void |
parseAbbrev(String select)
Callback, overridden by compiled code, which realizes a switch over all one character
option names.
|
protected void |
parseName(String select)
Callback, overridden by compiled code, which realizes a switch over all long
option names.
|
protected void |
parsePositionals()
Callback, overridden by compiled code, which calls one after the other
the positional parameters.
|
String |
serialize()
Called to generate a String representation of the model's state.
|
void |
usage_de()
Print usage information in the language 'de' on System.err.
|
void |
usage_de(PrintStream pr)
Print usage information in the language 'de'.
|
void |
usage_en()
Print usage information in the language 'en' on System.err.
|
void |
usage_en(PrintStream pr)
Print usage information in the language 'en'.
|
void |
usage(PrintStream pr)
Print usage information in the default language.
|
void |
usage(PrintStream pr,
String lang)
Print usage information in the requested language.
|
ARG_ERROR, ARG_ERROR, canReenterRepetitionGroup, convert_integer_10_or_16, descriptionKeyForCommentField, descriptionKeyForEnum, descriptionKeyForEnum, descriptionKeyForEnumItem, ERROR_plus, ERROR_UNKNOWN_ABBREV, ERROR_UNKNOWN_NAME, ERROR, getInputString, getMissingOptions, getNextToken_required, getNextToken, getParsingProtocol, HINT, INSITU, parse, parseBool_optional, parseBool, parseBoolTest, parseEnum, parseEnumSet, parseFloat, parseInit, parseInt_16or10, parseInt, parseOneString, parseOneString, parseOneUri, parseRational, parseString, putprot_option, putprot, serialize_hex, serialize, serialize, serialize, serialize, serialize, serialize, serialize, serialize, skipToOption, type_error, TYPE_MISMATCH, TYPE_MISMATCH, usage, usage, WARNING
protected boolean has_version
protected boolean value_version_0
protected boolean has_debuglevel
protected int value_debuglevel_0
protected boolean has_inputfile
protected String value_inputfile_0
protected boolean has_outputfile
protected String value_outputfile_0
protected boolean has_userCoords
protected int value_userCoords_0
protected int value_userCoords_1
protected int value_userCoords_2
protected int value_userCoords_3
protected boolean has_physCoords
protected int value_physCoords_0
protected int value_physCoords_1
protected MfOptions.physUnit value_physCoords_2
protected boolean has_timeFactor
protected double value_timeFactor_0
protected boolean has_interactive
protected boolean value_interactive_0
public MfOptions makeDefaultInstance()
eu.bandm.tools.option.runtime.Model
makeDefaultInstance
in class Model<MfOptions>
protected void checkActive()
eu.bandm.tools.option.runtime.Model
checkActive
in class Model<MfOptions>
@Deprecated public boolean has_version()
get_version_0()
.public boolean get_version_0()
version
.
-v / --version (bool)?(=true iff present)
@Deprecated public boolean has_debuglevel()
get_debuglevel_0()
.public int get_debuglevel_0()
debuglevel
.
-d / --debuglevel int(=0)
@Deprecated public boolean has_inputfile()
get_inputfile_0()
.public String get_inputfile_0()
inputfile
.
-0 / --inputfile uri(="")
@Deprecated public boolean has_outputfile()
get_outputfile_0()
.public String get_outputfile_0()
outputfile
.
-1 / --outputfile uri(="")
@Deprecated public boolean has_userCoords()
get_userCoords_0()
.public int get_userCoords_0()
userCoords
.
-u / --userCoords int(=20) int(=20) int(=70) int(=70)The other arguments of this option are accessed by the method(s) starting with
get_userCoords..
.public int get_userCoords_1()
userCoords
.
For details of this option see the method get_userCoords_0()
.public int get_userCoords_2()
userCoords
.
For details of this option see the method get_userCoords_0()
.public int get_userCoords_3()
userCoords
.
For details of this option see the method get_userCoords_0()
.@Deprecated public boolean has_physCoords()
get_physCoords_0()
.public int get_physCoords_0()
physCoords
.
-p / --physCoords int(=800) int(=800) physUnit(=px)The other arguments of this option are accessed by the method(s) starting with
get_physCoords..
.public int get_physCoords_1()
physCoords
.
For details of this option see the method get_physCoords_0()
.public MfOptions.physUnit get_physCoords_2()
physCoords
.
For details of this option see the method get_physCoords_0()
.@Deprecated public boolean has_timeFactor()
get_timeFactor_0()
.public double get_timeFactor_0()
timeFactor
.
--timeFactor float(=1.0)
@Deprecated public boolean has_interactive()
get_interactive_0()
.public boolean get_interactive_0()
interactive
.
-i / --interactive (bool)?(=true iff present)
public String serialize()
eu.bandm.tools.option.runtime.Model
public void usage(PrintStream pr)
public void usage(PrintStream pr, String lang)
public void usage_de()
public void usage_de(PrintStream pr)
public void usage_en()
public void usage_en(PrintStream pr)
protected void parseAbbrev(String select)
eu.bandm.tools.option.runtime.Model
parseAbbrev
in class Model<MfOptions>
select
- the one-character option name, as parsed by this code.protected void parseName(String select)
eu.bandm.tools.option.runtime.Model
protected int numberOfPositionals()
eu.bandm.tools.option.runtime.Model
numberOfPositionals
in class Model<MfOptions>
protected void parsePositionals()
eu.bandm.tools.option.runtime.Model
parsePositionals
in class Model<MfOptions>
protected void _finalCheck()
eu.bandm.tools.option.runtime.Model
_finalCheck
in class Model<MfOptions>
public String _getMissingOptions()
eu.bandm.tools.option.runtime.Model
_getMissingOptions
in class Model<MfOptions>
public String _getRedundantOptions()
eu.bandm.tools.option.runtime.Model
_getRedundantOptions
in class Model<MfOptions>