ParamInvalid Class Reference

Ratpac-two: RAT::Processor::ParamInvalid Class Reference
Ratpac-two
RAT::Processor::ParamInvalid Class Reference

#include <Processor.hh>

Inheritance diagram for RAT::Processor::ParamInvalid:
RAT::Processor::ParamError

Public Member Functions

 ParamInvalid (std::string _param, std::string _msg)
 
- Public Member Functions inherited from RAT::Processor::ParamError
 ParamError (std::string _param)
 

Public Attributes

std::string msg
 
- Public Attributes inherited from RAT::Processor::ParamError
std::string param
 

Detailed Description

Exception thrown when parameter name is known, but value is invalid.

Note that this class contains no member variable to hold the parameter value which caused the problem. This is because we do not know the type. You should mention the value inside the error message member variable instead. See dformat() for a nice function to format strings, much like sprintf().

Constructor & Destructor Documentation

◆ ParamInvalid()

RAT::Processor::ParamInvalid::ParamInvalid ( std::string  _param,
std::string  _msg 
)
inline

Create invalid parameter value error.

Parameters
[in]_paramName of parameter
[in]_msgMessage explaining problem with setting the value.

Member Data Documentation

◆ msg

std::string RAT::Processor::ParamInvalid::msg

Message explaining problem.


The documentation for this class was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/ratpac/checkouts/latest/src/core/include/RAT/Processor.hh