Parameter.h¶
Note
The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.
-
class
Parameter
¶ Base class for parameters.
-
explicit
Parameter
(std::string key)¶ Create parameter for given key
-
std::string
key
() const¶ Return parameter key
-
std::string
description
() const¶ Return parameter description
-
bool
is_set
() const¶ Return true if parameter is set, return false otherwise
-
void
reset
()¶ Reset the parameter to empty, so that is_set() returns false.
-
std::size_t
access_count
() const¶ Return access count (number of times parameter has been accessed)
-
std::size_t
change_count
() const¶ Return change count (number of times parameter has been changed)
-
void
set_range
(int min_value, int max_value)¶ Set range for int-valued parameter
-
void
set_range
(double min_value, double max_value)¶ Set range for double-valued parameter
-
void
set_range
(std::set<std::string> range)¶ Set range for string-valued parameter
-
void
get_range
(int &min_value, int &max_value) const¶ Get range for int-valued parameter
-
void
get_range
(double &min_value, double &max_value) const¶ Get range for double-valued parameter
-
void
get_range
(std::set<std::string> &range) const¶ Get range for string-valued parameter
-
operator int
() const¶ Cast parameter to int
-
operator std::size_t
() const¶ Cast parameter to std::size_t
-
operator double
() const¶ Cast parameter to double
-
operator std::string
() const¶ Cast parameter to string
-
operator bool
() const¶ Cast parameter to bool
-
std::string
type_str
() const = 0¶ Return value type string
-
std::string
value_str
() const = 0¶ Return value string
-
std::string
range_str
() const = 0¶ Return range string
-
std::string
str
() const = 0¶ Return short string description
-
explicit
-
class
IntParameter
¶ Parent class(es)
Parameter with value type int
-
explicit
IntParameter
(std::string key)¶ Create unset int-valued
-
IntParameter
(std::string key, int value)¶ Create int-valued parameter
-
void
set_range
(int min_value, int max_value)¶ Set range
-
void
get_range
(int &min_value, int &max_value) const¶ Get range
-
const IntParameter &
operator=
(int value)¶ Assignment
-
operator int
() const¶ Cast parameter to int
-
operator std::size_t
() const¶ Cast parameter to std::size_t
-
std::string
type_str
() const¶ Return value type string
-
std::string
value_str
() const¶ Return value string
-
std::string
range_str
() const¶ Return range string
-
std::string
str
() const¶ Return short string description
-
explicit
-
class
DoubleParameter
¶ Parent class(es)
Parameter with value type double
-
explicit
DoubleParameter
(std::string key)¶ Create unset double-valued parameter
-
DoubleParameter
(std::string key, double value)¶ Create double-valued parameter
-
void
set_range
(double min_value, double max_value)¶ Set range
-
void
get_range
(double &min_value, double &max_value) const¶ Get range
-
const DoubleParameter &
operator=
(double value)¶ Assignment
-
operator double
() const¶ Cast parameter to double
-
std::string
type_str
() const¶ Return value type string
-
std::string
value_str
() const¶ Return value string
-
std::string
range_str
() const¶ Return range string
-
std::string
str
() const¶ Return short string description
-
explicit
-
class
StringParameter
¶ Parent class(es)
Parameter with value type string
-
explicit
StringParameter
(std::string key)¶ Create unset string-valued parameter
-
StringParameter
(std::string key, std::string value)¶ Create string-valued parameter
-
void
set_range
(std::set<std::string> range)¶ Set range
-
void
get_range
(std::set<std::string> &range) const¶ Get range
-
const StringParameter &
operator=
(std::string value)¶ Assignment
-
const StringParameter &
operator=
(const char *value)¶ Assignment
-
operator std::string
() const¶ Cast parameter to string
-
std::string
type_str
() const¶ Return value type string
-
std::string
value_str
() const¶ Return value string
-
std::string
range_str
() const¶ Return range string
-
std::string
str
() const¶ Return short string description
-
explicit
-
class
BoolParameter
¶ Parent class(es)
Parameter with value type bool
-
explicit
BoolParameter
(std::string key)¶ Create unset bool-valued parameter
-
BoolParameter
(std::string key, bool value)¶ Create bool-valued parameter
-
const BoolParameter &
operator=
(bool value)¶ Assignment
-
operator bool
() const¶ Cast parameter to bool
-
std::string
type_str
() const¶ Return value type string
-
std::string
value_str
() const¶ Return value string
-
std::string
range_str
() const¶ Return range string
-
std::string
str
() const¶ Return short string description
-
explicit