class CommandOption

CommandOption is the base class for all command line options. More...

Full nameost::CommandOption
Definition#include <cmdoptns.h>
Inherited byCommandOptionArg, CommandOptionCollect, CommandOptionNoArg, CommandOptionRest, CommandOptionWithArg
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Members


Detailed Description

CommandOption is the base class for all command line options. Command line options can be defined statically and used when constructing a command line parser onject using MakeCommandOptionParse. This serves only as a base class to CommandOptionWithArg, CommandOptionRest or CommandOptionNoArg which can also be used to derive more complex classes or even entire applications.

const char * option_name

option_name

const char * option_letter

option_letter

const char * description

description

enum OptionType { HasArg, /** }

OptionType

This option is associated with a value

OptionType option_type

option_type

bool required

required

CommandOption * next

next

 ~CommandOption ()

~CommandOption

[virtual]

A virtual destructor just in case.

 CommandOption ( const char * in_option_name, const char * in_option_letter, const char * in_description, OptionType in_option_type, bool in_required = false, CommandOption ** pp_next = & DefaultCommandOptionList )

CommandOption

CommandOption contructor. Note the default values for required and pp_next.

Parameters:
in_option_namelong option name
in_option_lettershort letter name
in_descriptionshort description of the option
in_option_typethe type of this option
in_requiredtrue if option is required
pp_nextthe linked list header

void  FoundOption ( CommandOptionParse * cop, const char * value = 0 )

FoundOption

[virtual]

FoundOption is called by the CommandOptionParse object during the parsing of the command line options.

Parameters:
coppointer to the command option parser
valuethe value of this option

void  FoundOption ( CommandOptionParse * cop, const char ** value, int num )

FoundOption

[virtual]

FoundOption is called by the CommandOptionParse object during the parsing of the command line options.

Parameters:
coppointer to the command option parser
valuean array of values of this option
numnumber of values in the array

void  ParseDone ( CommandOptionParse * cop )

ParseDone

[virtual]

Once parsing of command line options is complete, this method is called. This can be used to perform last minute checks on the options collected.

Parameters:
coppointer to the command option parser

void  PerformTask ( CommandOptionParse * cop )

PerformTask

[virtual]

Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform. PerformTask must return.

Parameters:
coppointer to the command option parser

bool  HasValue ()

HasValue

[virtual]

For fields with the required flag set, this method is used to determine if the Option has satisfied it's required status. The default methods simply returns true if any values have been found. This could be specialized to return true based on some other criteria.