Hyperiso/APIAdapter_8h_source.html

#ifndef APIADAPTER_H

#define APIADAPTER_H


#include <unordered_set>

#include <map>


#include "Include.h"

#include "IMonitor.h"

#include "IPathProvider.h"

#include "IPathsProvider.h"

#include "IDataMonitor.h"

#include "MemoryManager.h"

#include "Parameters.h"


class APIAdapter : public IMonitor<ExternalFlag>,

                   public IPathProvider<APIPath>,

                   public IDataMonitor {

public:

    bool check_flag(ExternalFlag flag);


    fs::path get_path(APIPath path_name) override;


    std::unordered_set<BlockName> get_all_blocks();


    std::unordered_set<BlockName> get_blocks_list(ParameterType param_type = ParameterType::SM);


    std::map<LhaID, scalar_t> get_block_infos(const BlockName& block, ParameterType param_type = ParameterType::SM);


    std::vector<ParameterType> get_type_of_block(const BlockName& block);

};


#endif // APIADAPTER_H

ExternalFlag
ExternalFlag
Flags describing external input characteristics.
Definition Config.h:13

ParameterType
ParameterType
Definition GeneralEnum.h:633

ParameterType::SM
@ SM

IMonitor.h
Generic interface for monitoring flags within the framework.

IPathProvider.h
Interface for providing concrete filesystem paths based on enum identifiers.

IPathsProvider.h

APIPath
APIPath
Enumerates the filesystem paths exposed through the public API.
Definition IPathsProvider.h:16

Include.h

MemoryManager.h
Manages memory caching, parameter blocks, and LHA reader instances.

Parameters.h
Model-dependent parameter repository and initialization strategies.

APIAdapter
Concrete adapter combining monitoring and path providing functionalities.
Definition APIAdapter.h:54

APIAdapter::get_path
fs::path get_path(APIPath path_name) override
Retrieves a specific filesystem path exposed by APIPath.
Definition APIAdapter.cpp:15

APIAdapter::get_blocks_list
std::unordered_set< BlockName > get_blocks_list(ParameterType param_type=ParameterType::SM)
Retrieves block names for a specific parameter type.
Definition APIAdapter.cpp:7

APIAdapter::get_all_blocks
std::unordered_set< BlockName > get_all_blocks()
Retrieves all block names across all available model types.
Definition APIAdapter.cpp:19

APIAdapter::get_type_of_block
std::vector< ParameterType > get_type_of_block(const BlockName &block)
Retrieves the list of parameter types that own a specific block.
Definition APIAdapter.cpp:29

APIAdapter::check_flag
bool check_flag(ExternalFlag flag)
Checks the status of a specific external flag.
Definition APIAdapter.cpp:11

APIAdapter::get_block_infos
std::map< LhaID, scalar_t > get_block_infos(const BlockName &block, ParameterType param_type=ParameterType::SM)
Retrieves all parameter values inside a given block.
Definition APIAdapter.cpp:3

BlockName
Block identifier with alias support.
Definition BlockName.h:59

IDataMonitor
Interface for monitoring and retrieving information about parameter blocks.
Definition IDataMonitor.h:31

IMonitor
Interface for monitoring flags inside the framework (internal or external).
Definition IMonitor.h:32

IPathProvider
Interface for providing specific filesystem paths based on enumerated identifiers.
Definition IPathProvider.h:42

IDataMonitor.h
Interface for monitoring and retrieving information about parameter blocks.