ProvSQL C/C++ API
Adding support for provenance and uncertainty management to PostgreSQL databases
Loading...
Searching...
No Matches
CircuitRefusal Class Reference

A refusal by design, or a known gap, rather than an error. More...

#include "Circuit.h"

Inheritance diagram for CircuitRefusal:
Collaboration diagram for CircuitRefusal:

Public Member Functions

 CircuitRefusal (const char *scope, const char *tag, const std::string &m)
 Construct a refusal.
const char * scope () const noexcept
 The kind of the refusal.
const char * tag () const noexcept
 The tag of the refusal.
Public Member Functions inherited from CircuitException
 CircuitException (const std::string &m)
 Construct with a descriptive error message.
virtual char const * what () const noexcept
 Return the error message as a C-string.

Private Attributes

const char * scope_
 PROVSQL_DELIBERATE, PROVSQL_GAP, ...
const char * tag_
 Stable short tag of the refusal.

Detailed Description

A refusal by design, or a known gap, rather than an error.

Reported to the client as a ProvSQL refusal (SQLSTATE 0A000, with a provsql-reason tag and its scope; see provsql_unsupported), so that tooling can tell it from an internal fault.

Definition at line 408 of file Circuit.h.

Constructor & Destructor Documentation

◆ CircuitRefusal()

CircuitRefusal::CircuitRefusal ( const char * scope,
const char * tag,
const std::string & m )
inline

Construct a refusal.

Parameters
scopeIts kind (PROVSQL_DELIBERATE, PROVSQL_GAP, ...).
tagIts stable short tag.
mThe message a user reads.

Definition at line 420 of file Circuit.h.

Here is the call graph for this function:

Member Function Documentation

◆ scope()

const char * CircuitRefusal::scope ( ) const
inlinenoexcept

The kind of the refusal.

Definition at line 424 of file Circuit.h.

Here is the caller graph for this function:

◆ tag()

const char * CircuitRefusal::tag ( ) const
inlinenoexcept

The tag of the refusal.

Definition at line 428 of file Circuit.h.

Here is the caller graph for this function:

Member Data Documentation

◆ scope_

const char* CircuitRefusal::scope_
private

PROVSQL_DELIBERATE, PROVSQL_GAP, ...

Definition at line 410 of file Circuit.h.

◆ tag_

const char* CircuitRefusal::tag_
private

Stable short tag of the refusal.

Definition at line 411 of file Circuit.h.


The documentation for this class was generated from the following file:
  • /home/pierre/git/software/provsql/src/Circuit.h