ddt 1.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ddt::InformationMapsAccess Class Referenceabstract

#include <informationMapsAccess.hpp>

Inheritance diagram for ddt::InformationMapsAccess:
ddt::InformationMapsAccessFiles

Public Member Functions

virtual void LoadInformationMaps (const std::string info_map_source)=0
 

Protected Attributes

ddt::DdtLoggerlogger
 
std::unordered_map< std::string, boost::property_tree::ptree * > information_maps
 
 InformationMapsAccess ()
 
virtual ~InformationMapsAccess ()
 
virtual void set_logger (ddt::DdtLogger *const in_logger)
 
virtual std::list< std::string > get_InformationMaps ()
 
virtual boost::property_tree::ptree * get_InformationMap (const std::string identification)
 

Detailed Description

Class to wrap the usage of information map access functions.

Constructor & Destructor Documentation

◆ InformationMapsAccess()

InformationMapsAccess::InformationMapsAccess ( )
explicit

Constructor

◆ ~InformationMapsAccess()

InformationMapsAccess::~InformationMapsAccess ( )
virtualdefault

Destructor

Member Function Documentation

◆ get_InformationMap()

boost::property_tree::ptree * InformationMapsAccess::get_InformationMap ( const std::string  identification)
virtual

Get a information map in form of a boost property tree.

Parameters
identificationstring to identify the information map that is to be loaded
Returns
a boost property tree object containing the information map

◆ get_InformationMaps()

std::list< std::string > InformationMapsAccess::get_InformationMaps ( )
virtual

Get a list of information maps. The maps are identified using a string.

Returns
a list of information map identification strings

◆ LoadInformationMaps()

virtual void ddt::InformationMapsAccess::LoadInformationMaps ( const std::string  info_map_source)
pure virtual

Load the information maps from the specified information map source.

Parameters
info_map_sourcethe source of the information maps

Implemented in ddt::InformationMapsAccessFiles.

◆ set_logger()

void InformationMapsAccess::set_logger ( ddt::DdtLogger *const  in_logger)
virtual

Set logger

Parameters
in_loggerA DDT logger object (no transfer of ownership).

Member Data Documentation

◆ information_maps

std::unordered_map<std::string, boost::property_tree::ptree*> ddt::InformationMapsAccess::information_maps
protected

The collection of information maps

◆ logger

ddt::DdtLogger* ddt::InformationMapsAccess::logger
protected

The logger object


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