Camargue
Public Member Functions | List of all members
CMR::util::retcode_error Struct Reference

Structure for converting retcodes to exceptions. More...

#include <err_util.hpp>

Inheritance diagram for CMR::util::retcode_error:
Inheritance graph
[legend]
Collaboration diagram for CMR::util::retcode_error:
Collaboration graph
[legend]

Public Member Functions

 retcode_error (const int rval, const std::string &func_name)
 Construct a retcode_error with retcode and function name. More...
 

Detailed Description

Structure for converting retcodes to exceptions.

To be used with retcode-returning functions where different values signify different errors, meaningful for lookup.

Constructor & Destructor Documentation

CMR::util::retcode_error::retcode_error ( const int  rval,
const std::string &  func_name 
)
inline

Construct a retcode_error with retcode and function name.

Parameters
[in]rvalthe retcode from the function
[in]func_namethe name of the function that may fail, or a brief description of the task it performs.

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