Class
ArgParseOption
Stores information for a specific command line option.
ArgParseArgument
ArgParseOption
ArgParseOption
Include Headers
seqan/arg_parse.h
Remarks
A ArgParseOption object can be added to a ArgumentParser via addOption.
Member Functions
ArgParseOptionConstructor
Functions
addDefaultValueAdds/appends a new value to the list of default values.
addOptionAdds a ArgParseOption object to the ArgumentParser.
getArgumentLabelReturns the label for the given ArgParseArgument. Either the user defined label is returned or a default label (based on the ArgumentType is used).
getArgumentValueReturns the value of the ArgParseArgument object. If the ArgParseArgument is a list or can hold multiple values (numberOfArguments) you can specify which value you want to get. If not set the first value will be returned. Retrieves the value of an argument given by its position.
getArgumentValuesReturns all values of the ArgParseArgument object as const std::vector. Returns all values of an option given on the command line.
hasDefaultReturns true if a default value was given for that argument. Returns whether an option has a default value or not.
hasValue 
hideOptionHides the ArgParseOption from the help screen. Hides the ArgParseOption defined by the parameter name (which can be either the short or the long name) from the help screen.
isBooleanOptionReturns whether option is a switch.
isDoubleArgumentReturns whether the argument is a double.
isInputFileArgumentReturns whether the argument is an input file.
isIntegerArgumentReturns whether the argument is an integer.
isListArgumentReturns whether the argument can be given multiple times.
isOutputFileArgumentReturns whether the argument is an output file.
isRequiredReturns whether the option is mandatory.
isSetReturns true if a value was assigned to the argument. Returns whether an option was set on the parsed command line.
isStringArgumentReturns whether the argument is a string.
isVisibleReturns whether option is visible on the help screen. Default is true.
numberOfAllowedValuesReturns the number of allowed values for this ArgParseArgument.
setDefaultValueSets the default value for the given option.
setMaxValueSets the maximum value of a ArgParseArgument object.
setMinValueSets the minimum value of a ArgParseArgument object.
setRequiredSets whether or not the option is mandatory. Sets whether or not the option defined by the parameter name (which can be either the short or the long name) is mandatory.
setValidValuesSets the set of allowed values of a ArgParseArgument object.
writeSaves records to a file. Writes the basic information about the ArgParseOption to the provided stream.
SeqAn - Sequence Analysis Library - www.seqan.de
 

Page built @2012/10/02 11:10:28