Scarab  v3.4.1
Project 8 C++ Utility Library
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
RequiredError Class Reference

Thrown when a required option is missing. More...

#include <CLI11.hpp>

Inheritance diagram for RequiredError:
Inheritance graph

Public Member Functions

 RequiredError (std::string msg, ExitCodes exit_code)
 
 RequiredError (std::string msg, int exit_code)
 
 RequiredError (std::string name)
 
- Public Member Functions inherited from ParseError
 ParseError (std::string msg, ExitCodes exit_code)
 
 ParseError (std::string msg, int exit_code)
 
- Public Member Functions inherited from Error
int get_exit_code () const
 
std::string get_name () const
 
 Error (std::string name, std::string msg, int exit_code=static_cast< int >(ExitCodes::BaseClass))
 
 Error (std::string name, std::string msg, ExitCodes exit_code)
 

Static Public Member Functions

static RequiredError Subcommand (size_t min_subcom)
 
static RequiredError Option (size_t min_option, size_t max_option, size_t used, const std::string &option_list)
 

Protected Member Functions

 RequiredError (std::string ename, std::string msg, int exit_code)
 
 RequiredError (std::string ename, std::string msg, ExitCodes exit_code)
 
- Protected Member Functions inherited from ParseError
 ParseError (std::string ename, std::string msg, int exit_code)
 
 ParseError (std::string ename, std::string msg, ExitCodes exit_code)
 

Detailed Description

Thrown when a required option is missing.

Definition at line 778 of file CLI11.hpp.

Constructor & Destructor Documentation

◆ RequiredError() [1/5]

RequiredError ( std::string  ename,
std::string  msg,
int  exit_code 
)
inlineprotected

Definition at line 779 of file CLI11.hpp.

◆ RequiredError() [2/5]

RequiredError ( std::string  ename,
std::string  msg,
ExitCodes  exit_code 
)
inlineprotected

Definition at line 779 of file CLI11.hpp.

◆ RequiredError() [3/5]

RequiredError ( std::string  msg,
ExitCodes  exit_code 
)
inline

Definition at line 779 of file CLI11.hpp.

◆ RequiredError() [4/5]

RequiredError ( std::string  msg,
int  exit_code 
)
inline

Definition at line 779 of file CLI11.hpp.

◆ RequiredError() [5/5]

RequiredError ( std::string  name)
inlineexplicit

Definition at line 780 of file CLI11.hpp.

Member Function Documentation

◆ Option()

static RequiredError Option ( size_t  min_option,
size_t  max_option,
size_t  used,
const std::string &  option_list 
)
inlinestatic

Definition at line 788 of file CLI11.hpp.

◆ Subcommand()

static RequiredError Subcommand ( size_t  min_subcom)
inlinestatic

Definition at line 781 of file CLI11.hpp.


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