CommandLineOption Class Reference

#include <CommandLineOption.hpp>

List of all members.

Public Types
enum	ArgumentsType { integer, real, string, end }
Public Member Functions
const std::string &	shortName () const
const std::string &	longName () const
const std::string &	description () const
const std::string	arguments () const
const int &	identifier () const
	CommandLineOption (const int &id, const std::string &longName, const std::string &shortName, const std::string &description, ArgumentsType arguments[]=0)
	~CommandLineOption ()
Private Attributes
const int	__identifier
const std::string	__longName
const std::string	__shortName
const std::string	__description
std::vector< ArgumentsType >	__arguments

---

Detailed Description

Definition at line 38 of file CommandLineOption.hpp.

---

Member Enumeration Documentation

enum CommandLineOption::ArgumentsType

Enumerator:

integer
real
string
end

Definition at line 41 of file CommandLineOption.hpp.

  {
    integer,
    real,
    string,
    end
  };

---

Constructor & Destructor Documentation

CommandLineOption::CommandLineOption	(	const int &	id,
		const std::string &	longName,
		const std::string &	shortName,
		const std::string &	description,
		ArgumentsType	arguments[] = 0
	)			[inline]

Constructor

Definition at line 132 of file CommandLineOption.hpp.

References __arguments, arguments(), and end.

    : __identifier(id),
      __longName(longName),
      __shortName(shortName),
      __description(description)
  {
    if (arguments != 0) {
      for (int i=0; arguments[i]!=CommandLineOption::end; ++i) {
        __arguments.push_back(arguments[i]);
      }
    }
  }

Here is the call graph for this function:

CommandLineOption::~CommandLineOption

(

)

[inline]

Destructor

Definition at line 152 of file CommandLineOption.hpp.

  {
    ;
  }

---

Member Function Documentation

const std::string& CommandLineOption::shortName

(

)

const [inline]

Returns the short name of an option

Returns:

__shortName

Definition at line 64 of file CommandLineOption.hpp.

References __shortName.

Referenced by CommandLineParser::CommandLineParser().

  {
    return __shortName;
  }

const std::string& CommandLineOption::longName

(

)

const [inline]

Returns the long name of an option

Returns:

__longName

Definition at line 74 of file CommandLineOption.hpp.

References __longName.

Referenced by CommandLineParser::CommandLineParser().

  {
    return __longName;
  }

const std::string& CommandLineOption::description

(

)

const [inline]

Returns the description of an option

Returns:

__description

Definition at line 84 of file CommandLineOption.hpp.

References __description.

  {
    return __description;
  }

const std::string CommandLineOption::arguments

(

)

const [inline]

Definition at line 89 of file CommandLineOption.hpp.

References __arguments, end, integer, real, string, and ErrorHandler::unexpected.

Referenced by CommandLineOption().

  {
    std::string argument;
    for (size_t i=0; i<__arguments.size(); ++i) {
      if (i!=0) argument += ',';
      switch (__arguments[i]) {
      case CommandLineOption::integer: {
        argument += "int";
        break;
      }
      case CommandLineOption::real: {
        argument += "real";
        break;
      }
      case CommandLineOption::string: {
        argument += "str";
        break;
      }
      case CommandLineOption::end:
      default: {
        throw ErrorHandler(__FILE__,__LINE__,
                           "unexpected command line option",
                           ErrorHandler::unexpected);
      }
      }
    }
    return argument;
  }

const int& CommandLineOption::identifier

(

)

const [inline]

Returns option idetifier

Returns:

__identifier

Definition at line 123 of file CommandLineOption.hpp.

References __identifier.

Referenced by CommandLineParser::__treatOption().

  {
    return __identifier;
  }

---

Member Data Documentation

const int CommandLineOption::__identifier [private]

Option id

Definition at line 50 of file CommandLineOption.hpp.

Referenced by identifier().

const std::string CommandLineOption::__longName [private]

long name (--help for instance)

Definition at line 52 of file CommandLineOption.hpp.

Referenced by longName().

const std::string CommandLineOption::__shortName [private]

short name (-h for instance)

Definition at line 53 of file CommandLineOption.hpp.

Referenced by shortName().

const std::string CommandLineOption::__description [private]

Description of the option

Definition at line 54 of file CommandLineOption.hpp.

Referenced by description().

std::vector<ArgumentsType> CommandLineOption::__arguments [private]

Arguments type

Definition at line 55 of file CommandLineOption.hpp.

Referenced by arguments(), and CommandLineOption().

---

The documentation for this class was generated from the following file:

• CommandLineOption.hpp