helicscpp::hThrowOnError Class Reference

#include <helicsExceptions.hpp>

Public Member Functions
	hThrowOnError ()
	~hThrowOnError () HELICS_THROWS_EXCEPTION
	operator HelicsError * ()

Detailed Description

helper class that will throw an error if the helics error object has a actual error in it

it will throw an in the destructor

Constructor & Destructor Documentation

hThrowOnError()

helicscpp::hThrowOnError::hThrowOnError ( )

inline

constructor which creates and initializing an error object

~hThrowOnError()

helicscpp::hThrowOnError::~hThrowOnError ( )

inline

throwing destructor

if the error code object contains a non-zero error code the destructor will emit an exception

References HelicsError::error_code, and HelicsError::message.

Member Function Documentation

operator HelicsError *()

helicscpp::hThrowOnError::operator HelicsError * ( )

inline

this is an implicit conversion operation for use with HelicsError

---

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

• helicsExceptions.hpp