Member Function
CommandLineOption
Constructor
CommandLineOption ()
CommandLineOption (shortName, longName[, argumentsPerOption], helpText, optionType[, defaultValue])
Parameters
shortName
A CharString containing the short-name option identifier (e.g. "h" for the -h/--help option). Although not suggested the short-name can contain more than 1 character.
Remarks: Note that the leading "-" is not passed.
longName
A CharString containing the long-name option identifier (e.g. "help" for the -h/--help option).
Types: CharString
Remarks: Note that the leading "--" is not passed.
argumentsPerOption
The number of required arguments per option (e.g. if set to 3 then 3 arguments must follow the option: "-foo x1 x2 x3").
Default: 0 for boolean options and 1 for the rest.
helpText
A CharString containing the help text associated with this option.
Types: CharString
optionType
Option type. This can be the sum of the some of the following values:
Flag
Value
Description
OptionType::Bool or OptionType::Boolean1Option needs no argument, value is true iff given on command line
OptionType::String2Argument is a string
OptionType::Int or OptionType::Integer4An integer
OptionType::Double8A float
OptionType::Mandatory16Option must be set
OptionType::Label32Automatically print a label for the argument(s) on the help screen
OptionType::List64Option is a list of values
OptionType::Hidden128Hide this option from the help screen
defaultValue
The default value of this option.
Default: No default value.
SeqAn - Sequence Analysis Library - www.seqan.de
 

Page built @2011/02/08 21:37:08