Abstract provider of Node-based views of external data. More...

#include <IDBNodeProvider.h>

Inheritance diagram for IDBNodeProvider:

[legend]

Public Member Functions
	IDBNodeProvider (fs::path src_path_)
	Constructs a provider bound to a given source path.

virtual	~IDBNodeProvider ()=default

virtual std::shared_ptr< DBNode >	provide_db_as_node ()=0
	Returns the underlying data as a DBNode tree.

Protected Attributes
fs::path	src_path

Detailed Description

Abstract provider of Node-based views of external data.

An IDBNodeProvider typically:

stores the location of the underlying data (e.g. a file path),
offers a single method to materialize that data as a DBNode tree.

Concrete implementations in this project:

DictNodeProvider: for JSON/YAML configuration files,
LhaNodeProvider: for LHA/SLHA/FLHA input files.

Definition at line 31 of file IDBNodeProvider.h.

Constructor & Destructor Documentation

◆ IDBNodeProvider()

IDBNodeProvider::IDBNodeProvider ( fs::path src_path_ )

inline

Constructs a provider bound to a given source path.

Parameters

src_path Location of the backing resource to read from.

Definition at line 41 of file IDBNodeProvider.h.

◆ ~IDBNodeProvider()

virtual IDBNodeProvider::~IDBNodeProvider ( )

virtualdefault

Member Function Documentation

◆ provide_db_as_node()

virtual std::shared_ptr< DBNode > IDBNodeProvider::provide_db_as_node ( )

pure virtual

Returns the underlying data as a DBNode tree.

Implementations are free to choose how they obtain the DBNode:

parsing a file (via DBManager),
querying a database,
composing multiple sources, etc.

Returns: Shared pointer to the root NDBode representing the data.

Exceptions

std::runtime_error or implementation-specific exceptions in case of I/O or parsing failures.

Implemented in DictDBNodeProvider, and LhaDBNodeProvider.

Member Data Documentation

◆ src_path

fs::path IDBNodeProvider::src_path

protected

Definition at line 33 of file IDBNodeProvider.h.

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

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/DataBase/ports/IDBNodeProvider.h

Public Member Functions

Protected Attributes