optionpp::parse_error Class Reference

Exception class indicating an invalid option. More...

#include <parser.hpp>

Inheritance diagram for optionpp::parse_error:

Collaboration diagram for optionpp::parse_error:

Public Member Functions
	parse_error (const std::string msg, const std::string fn_name, const std::string option="")
	Constructor. More...
const std::string &	option () const noexcept
	Return option name. More...
Public Member Functions inherited from optionpp::error
	error (const std::string &msg, const std::string &fn_name)
	Constructor. More...
const std::string &	function () const
	Return the name of function that threw the exception. More...

Detailed Description

Exception class indicating an invalid option.

Constructor & Destructor Documentation

parse_error()

optionpp::parse_error::parse_error ( const std::string  msg, const std::string  fn_name, const std::string  option = ""  )

inline

Constructor.

Parameters

msg	String describing the error.
fn_name	Name of the function that threw the exception.
option	Name of the option that triggered the error (if any).

Member Function Documentation

option()

const std::string& optionpp::parse_error::option ( ) const

inlinenoexcept

Return option name.

Returns

Option that triggered the error, if any.

---

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

• /home/gkikola/Code/optionpp/include/optionpp/parser.hpp