DGtal 1.3.0
|
#include <DGtal/helpers/Parameters.h>
Public Types | |
typedef Parameters | Self |
The type of *this. More... | |
Public Member Functions | |
Parameters ()=default | |
Default constructor. More... | |
~Parameters ()=default | |
Default destructor. More... | |
Parameters (const Self &other)=default | |
Default copy constructor. More... | |
Parameters (Self &&other)=default | |
Default move. More... | |
Self & | operator= (const Self &other)=default |
Default assignment operator. More... | |
Parameters (std::string name, ParameterValue pv=ParameterValue()) | |
Self & | operator() (std::string name, ParameterValue pv=ParameterValue()) |
Self & | operator() (const Self ¶ms) |
ParameterValue | operator[] (std::string name) const |
bool | count (std::string name) const |
Self | operator| (const Self &other) const |
void | selfDisplay (std::ostream &out) const |
bool | isValid () const |
Protected Attributes | |
std::map< std::string, ParameterValue > | myParameters |
This class represents a set of (input) simple parameters, i.e. mapping names to values.
Definition at line 146 of file Parameters.h.
typedef Parameters DGtal::Parameters::Self |
The type of *this.
Definition at line 148 of file Parameters.h.
|
default |
Default constructor.
|
default |
Default destructor.
|
default |
Default copy constructor.
|
default |
Default move.
DGtal::Parameters::Parameters | ( | std::string | name, |
ParameterValue | pv = ParameterValue() |
||
) |
Constructor. Add parameter (name) or (name,pv)
[in] | name | the name of the parameter. |
[in] | pv | the value of the parameter (string,int,float,double). |
bool DGtal::Parameters::count | ( | std::string | name | ) | const |
[in] | name | any parameter name |
bool DGtal::Parameters::isValid | ( | ) | const |
Checks the validity/consistency of the object.
Add parameters params to this object.
[in] | params | a set of parameters |
Self & DGtal::Parameters::operator() | ( | std::string | name, |
ParameterValue | pv = ParameterValue() |
||
) |
Add parameter (name) or (name,pv).
[in] | name | the name of the parameter. |
[in] | pv | the value of the parameter (string,int,float,double). |
ParameterValue DGtal::Parameters::operator[] | ( | std::string | name | ) | const |
[in] | name | any parameter name |
Merge the two parameter sets and returns a new one.
[in] | other | a set of parameters |
void DGtal::Parameters::selfDisplay | ( | std::ostream & | out | ) | const |
Writes/Displays the object on an output stream.
out | the output stream where the object is written. |
|
protected |
Definition at line 198 of file Parameters.h.