version 3.10-dev
Dumux::MetaData::Collector Class Reference

Class to collect metadata.

#include <dumux/common/metadata.hh>

Public Member Functions

JsonTree & getTree ()
 Get the json tree. More...
 
const JsonTree & getTree () const
 
void merge (const Collector &collector)
 Merges two trees by overwriting existing values. More...
 
void append (const Collector &collector, bool convertToArrays=false)
 Append data from another collector. More...
 
auto & operator[] (const std::string &id)
 returns the object with id of the json tree More...
 

Static Public Member Functions

template<class T >
static std::string className (const T &c, bool hideTemplates)
 
template<class T >
static std::string className (bool hideTemplates)
 
static std::string hideTemplateArguments (std::string &&s)
 

Member Function Documentation

◆ append()

void Dumux::MetaData::Collector::append ( const Collector collector,
bool  convertToArrays = false 
)
inline
Parameters
collectorThe json collector from which data is taken
convertToArraysConvert non-array types to array which allows appending data

◆ className() [1/2]

template<class T >
static std::string Dumux::MetaData::Collector::className ( bool  hideTemplates)
inlinestatic

◆ className() [2/2]

template<class T >
static std::string Dumux::MetaData::Collector::className ( const T &  c,
bool  hideTemplates 
)
inlinestatic

◆ getTree() [1/2]

JsonTree & Dumux::MetaData::Collector::getTree ( )
inline

◆ getTree() [2/2]

const JsonTree & Dumux::MetaData::Collector::getTree ( ) const
inline

◆ hideTemplateArguments()

static std::string Dumux::MetaData::Collector::hideTemplateArguments ( std::string &&  s)
inlinestatic

◆ merge()

void Dumux::MetaData::Collector::merge ( const Collector collector)
inline

◆ operator[]()

auto & Dumux::MetaData::Collector::operator[] ( const std::string &  id)
inline

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