sparta::ParameterException Class Reference

Exception indicating a misconfigured Parameter or invalid Parameter access. More...

#include <Parameter.hpp>

Inheritance diagram for sparta::ParameterException:

Collaboration diagram for sparta::ParameterException:

Public Member Functions
	ParameterException ()=default
	Default construction (rule of 3)
	ParameterException (const ParameterException &)=default
	Default copy (rule of 3)
	ParameterException (const std::string &reason)
	Construct with a default string.
virtual	~ParameterException () noexcept
	Destructor.
template<class T >
ParameterException &	operator<< (const T &msg)
	Wrapper around SpartaException::operator<<.
Public Member Functions inherited from sparta::SpartaException
	SpartaException ()
	Construct a SpartaException object with empty reason.
	SpartaException (const std::string &reason)
	Construct a SpartaException object.
	SpartaException (const SpartaException &orig)
	Copy construct a SpartaException object.
virtual	~SpartaException () noexcept
	Destroy!
const char *	what () const noexcept
	Overload from std::exception.
std::string	backtrace () const noexcept
	Returns the backtrace at the time this exception was generated.
std::string	rawReason () const
	Return the raw reason without file, line information.
template<class T >
SpartaException &	operator<< (const T &msg)
	Append additional information to the message.

Detailed Description

Exception indicating a misconfigured Parameter or invalid Parameter access.

Definition at line 57 of file Parameter.hpp.

Constructor & Destructor Documentation

ParameterException()

sparta::ParameterException::ParameterException ( const std::string &  reason )

inline

Construct with a default string.

Note

Stream insertion operator can be used to add more text to the reason.

Definition at line 71 of file Parameter.hpp.

~ParameterException()

virtual sparta::ParameterException::~ParameterException ( )

inlinevirtualnoexcept

Destructor.

Definition at line 78 of file Parameter.hpp.

Member Function Documentation

operator<<()

template<class T >

ParameterException & sparta::ParameterException::operator<< ( const T &  msg )

inline

Wrapper around SpartaException::operator<<.

Definition at line 84 of file Parameter.hpp.

Here is the call graph for this function:

---

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

• /github/workspace/sparta/sparta/simulation/Parameter.hpp