Class SwitchArg

Inheritance Relationships

Base Type

Derived Type

Class Documentation

class SwitchArg : public ecl::Arg

A simple switch argument. If the switch is set on the command line, then the getValue method will return the opposite of the default value for the switch.

Subclassed by ecl::MultiSwitchArg

Public Functions

inline SwitchArg(const std::string &flag, const std::string &name, const std::string &desc, bool def = false, Visitor *v = NULL)

SwitchArg constructor.

Parameters:

  • flag – - The one character flag that identifies this argument on the command line.

  • name – - A one word name for the argument. Can be used as a long flag on the command line.

  • desc – - A description of what the argument is for or does.

  • def – - The default value for this Switch.

  • v – - An optional visitor. You probably should not use this unless you have a very good reason.

inline SwitchArg(const std::string &flag, const std::string &name, const std::string &desc, CmdLineInterface &parser, bool def = false, Visitor *v = NULL)

SwitchArg constructor.

Parameters:

  • flag – - The one character flag that identifies this argument on the command line.

  • name – - A one word name for the argument. Can be used as a long flag on the command line.

  • desc – - A description of what the argument is for or does.

  • parser – - A CmdLine parser object to add this Arg to

  • def – - The default value for this Switch.

  • v – - An optional visitor. You probably should not use this unless you have a very good reason.

inline virtual bool processArg(int *i, std::vector<std::string> &args)

Handles the processing of the argument. This re-implements the Arg version of this method to set the _value of the argument appropriately.

Parameters:

  • i – - Pointer the the current argument in the list.

  • args – - Mutable list of strings. Passed in from main().

inline bool combinedSwitchesMatch(std::string &combined)

Checks a string to see if any of the chars in the string match the flag for this Switch.

inline bool getValue()

Returns bool, whether or not the switch has been set.

Protected Attributes

bool _value

The value of the switch.