AnCH Framework 0.1
Another C++ Hack Framework
 
Loading...
Searching...
No Matches
anch::resource::Resource Class Reference

#include <resource.hpp>

+ Collaboration diagram for anch::resource::Resource:

Public Member Functions

virtual ~Resource ()
 
bool getParameter (std::string &value, const std::string &param, const std::string &section="") const
 
std::optional< anch::resource::Sectionsection (const std::string &section) const
 
std::optional< std::string > parameter (const std::string &param) const
 
const std::map< std::string, anch::resource::Section > & getConfiguration () const
 

Static Public Member Functions

static const ResourcegetResource (const std::string &filePath)
 

Detailed Description

Resource manager

Author
Vincent Lachenal

Constructor & Destructor Documentation

◆ ~Resource()

virtual anch::resource::Resource::~Resource ( )
virtual

Resource destructor

Member Function Documentation

◆ getConfiguration()

const std::map< std::string, anch::resource::Section > & anch::resource::Resource::getConfiguration ( ) const

Get resource configuration

Returns
The configuration

◆ getParameter()

bool anch::resource::Resource::getParameter ( std::string & value,
const std::string & param,
const std::string & section = "" ) const

Get parameter value from its name and section

Parameters
valueThe value to set
paramThe parameter to find
sectionThe parameter section (optional)
Returns
true if value has been found, false otherwise.
+ Here is the call graph for this function:

◆ getResource()

static const Resource & anch::resource::Resource::getResource ( const std::string & filePath)
static

Get Resource instance from file

Parameters
filePathThe resource file path
Returns
The Resource unique instance

◆ parameter()

std::optional< std::string > anch::resource::Resource::parameter ( const std::string & param) const

Access parameter without section

Parameters
paramthe parameter name
Returns
the optional result

◆ section()

std::optional< anch::resource::Section > anch::resource::Resource::section ( const std::string & section) const

Access section

Parameters
sectionthe section name
Returns
the optional result
+ Here is the call graph for this function:

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