OpenMS  2.8.0
Public Member Functions | List of all members
InvalidValue Class Reference

Invalid value exception. More...

#include <OpenMS/CONCEPT/Exception.h>

Inheritance diagram for InvalidValue:
[legend]
Collaboration diagram for InvalidValue:
[legend]

Public Member Functions

 InvalidValue (const char *file, int line, const char *function, const std::string &message, const std::string &value) noexcept
 
- Public Member Functions inherited from BaseException
 BaseException () noexcept
 Default constructor. More...
 
 BaseException (const char *file, int line, const char *function) noexcept
 Constructor. More...
 
 BaseException (const char *file, int line, const char *function, const std::string &name, const std::string &message) noexcept
 Constructor. More...
 
 BaseException (const BaseException &exception) noexcept
 Copy constructor. More...
 
 ~BaseException () noexcept override
 Destructor. More...
 
const char * getName () const noexcept
 Returns the name of the exception. More...
 
int getLine () const noexcept
 Returns the line number where it occurred. More...
 
const char * getFile () const noexcept
 Returns the file where it occurred. More...
 
const char * getFunction () const noexcept
 Returns the function where it occurred. More...
 
const char * getMessage () const noexcept
 Returns the message. More...
 

Additional Inherited Members

- Protected Attributes inherited from BaseException
const char * file_
 The source file the exception was thrown in. More...
 
int line_
 The line number the exception was thrown in. More...
 
const char * function_
 The source file the exception was thrown in. More...
 
std::string name_
 The name of the exception. More...
 

Detailed Description

Invalid value exception.

Use this exception to indicate that a given value is not valid, when the value is only allowed to be out of a certain set of values. If the value has to be inside a given range, you should rather use OutOfRange.

Constructor & Destructor Documentation

◆ InvalidValue()

InvalidValue ( const char *  file,
int  line,
const char *  function,
const std::string &  message,
const std::string &  value 
)
noexcept