OpenFCST: The open-source Fuel Cell Simulation Toolbox
|
Convenient storage object for SolutionVariables. More...
#include <fcst_variables.h>
Public Member Functions | |
void | push_back (const SolutionVariable &a) |
Public function for adding SolutionVariable, uses the VariableNames stored within the SolutionVariable as a key. More... | |
SolutionVariable & | at (VariableNames key) |
Expose std::map<VariableNames, SolutionVariable>::at() interface publicly. More... | |
void | clear () |
Expose std::map<VariableNames, SolutionVariable>::clear() interface publicly. More... | |
void | erase (const VariableNames &v) |
Expose std::map<VariableNames, SolutionVariable>::erase() interface publicly. More... | |
bool | has (const VariableNames &v) const |
Find if a solution corresponding VariableNames type exist inside map. More... | |
SolutionVariable | pop (const VariableNames &v) |
Returns and entry whilst removing it from the list. More... | |
Convenient storage object for SolutionVariables.
Used for storing and passing sets of solutions.
Inherits of std::map< VariableNames, SolutionVariable> privately, as to no expose operator[] since we wish to check all map inserts
Simply add Solutions using push_back(), and access them as normal using the at() function. To determine if a SolutionMap has a certain SolutionVariable corresponding to a VariableNames use the has() function.
|
inline |
Expose std::map<VariableNames, SolutionVariable>::at() interface publicly.
|
inline |
Expose std::map<VariableNames, SolutionVariable>::clear() interface publicly.
|
inline |
Expose std::map<VariableNames, SolutionVariable>::erase() interface publicly.
|
inline |
Find if a solution corresponding VariableNames type exist inside map.
|
inline |
Returns and entry whilst removing it from the list.
|
inline |
Public function for adding SolutionVariable, uses the VariableNames stored within the SolutionVariable as a key.
To circumvent this either clear the map using clear(), or to replace a single element first using erase(key) to clear existing SolutionVariable corresponding to the same VariableNames type or pop(key) to get the SolutionVariable whilst simulataneously erasing it.
References FuelCellShop::SolutionVariable::get_variablename().