Hermes::Api Class Reference

API Class containing settings for the whole HermesCommon. More...

#include <api.h>

Classes
class	Parameter

Public Types
typedef void(*	SetterHandler )()

Public Member Functions
int	get_integral_param_value (HermesCommonApiParam)
void	set_integral_param_value (HermesCommonApiParam, int value)

Protected Attributes
std::map< HermesCommonApiParam, Parameter * >	parameters
std::map< HermesCommonApiParam, SetterHandler >	setter_handlers
std::map< std::pair < HermesCommonApiParam, int > , SetterHandler >	value_setter_handlers
std::map< std::pair < HermesCommonApiParam, int > , SetterHandler >	change_handlers

Detailed Description

API Class containing settings for the whole HermesCommon.

Definition at line 44 of file api.h.

Member Typedef Documentation

typedef void(* Hermes::Api::SetterHandler)()

Internal. Setter handler type. Serve for a custom reaction to some parameter settings. Such a handler must be registered in the map setter_handlers.

Definition at line 54 of file api.h.

Member Data Documentation

std::map<std::pair<HermesCommonApiParam, int>, SetterHandler> Hermes::Api::change_handlers

protected

Internal. Change handlers. Used when the value of a particular parameter changes from the served one to another. Also used in destructor.

Definition at line 90 of file api.h.

std::map<HermesCommonApiParam, Parameter*> Hermes::Api::parameters

protected

The storage of parameters. This storage is not optimized for speed, but for comfort of users. There should not be any parameters, values of which are sought very often, because of the above reason.

Definition at line 73 of file api.h.

std::map<HermesCommonApiParam, SetterHandler> Hermes::Api::setter_handlers

protected

Internal. Setter handlers without value. Purpose: when a parameter is set (such as the linear solver), some action might have to be taken to serve the event.

Definition at line 79 of file api.h.

std::map<std::pair<HermesCommonApiParam, int>, SetterHandler> Hermes::Api::value_setter_handlers

protected

Setter handlers with specific value. Purpose: when a parameter is set (such as the linear solver), some action might have to be taken to serve the event.

Definition at line 84 of file api.h.

---

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

• api.h
• api.cpp