PDI 1.12.0-alpha.2026-05-07

the PDI data interface

PDI::Spectree_error Class Reference

An error class to use when there is an invalid entry in the specification tree. More...

#include <error.h>

Inheritance diagram for PDI::Spectree_error:
PDI::Error

Public Member Functions

 Spectree_error (PC_tree_t tree, std::string what)
 Creates a new Spectree_error.
template<typename... Args>
 Spectree_error (PC_tree_t tree, fmt::format_string< Args... > format_str, Args &&... args)
 Creates a new Spectree_error.
std::string full_msg () const override
 Gives access to a full error message.
void rethrow_with_context (std::string msg) const override
 Rethrow the error with some context prepended to its description.

Detailed Description

An error class to use when there is an invalid entry in the specification tree.

Constructor & Destructor Documentation

◆ Spectree_error() [1/2]

PDI::Spectree_error::Spectree_error ( PC_tree_t tree,
std::string what )

Creates a new Spectree_error.

Parameters
[in]treethe subtree that's in error
[in]whatan error message

◆ Spectree_error() [2/2]

template<typename... Args>
PDI::Spectree_error::Spectree_error ( PC_tree_t tree,
fmt::format_string< Args... > format_str,
Args &&... args )
inline

Creates a new Spectree_error.

Parameters
[in]treethe subtree that's in error
[in]format_stran error message as a python-style format
[in]argsthe fmt parameters for the message

Member Function Documentation

◆ full_msg()

std::string PDI::Spectree_error::full_msg ( ) const
overridevirtual

Gives access to a full error message.

The message includes all available context as well as the info about error type

Returns
the full message

Implements PDI::Error.

◆ rethrow_with_context()

void PDI::Spectree_error::rethrow_with_context ( std::string context) const
overridevirtual

Rethrow the error with some context prepended to its description.

Parameters
contextthe context to prepend to the error message

Implements PDI::Error.


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