Class _Switch
source code
_AbstractParameter --+
|
_Switch
Represent an optional argument switch for a program.
This holds UNIXish options like -kimura in clustalw which don't take a
value, they are either included in the command string or omitted.
o names -- a list of string names by which the parameter can be
referenced (ie. ["-a", "--append",
"append"]). The first name in the list is considered to be the
one that goes on the commandline, for those parameters that print the
option. The last name in the list is assumed to be a "human
readable" name describing the option in one word.
o param_types -- a list of string describing the type of parameter,
which can help let programs know how to use it. Example descriptions
include 'input', 'output', 'file'. Note that if 'file' is included,
these argument values will automatically be escaped if the filename
contains spaces.
o description -- a description of the option.
o is_set -- if the parameter has been set
NOTE - There is no value attribute, see is_set instead,