ParameterValue

class dolfin.cpp.common.ParameterValue(*args, **kwargs)

Bases: object

Base class for parameters.

Type_Bool = 0
Type_Float = 2
Type_Int = 1
Type_String = 3
access_count()

Return access count (number of times parameter has been accessed)

Return type:std::size_t
Returns:std::size_t
change_count()

Return change count (number of times parameter has been changed)

Return type:std::size_t
Returns:std::size_t
static check_key()

Check that key name is allowed.

Parameters:key (std::string) –
Return type:void
data()
description()

Return parameter description

Return type:std::string
Returns:std::string
get_range()
is_set()

Return true if parameter is set, return false otherwise

Return type:bool
Returns:bool
key()

Return parameter key

Return type:std::string
Returns:std::string
range_str()

Return range string.

Return type:std::string
reset()

Reset the parameter to empty, so that is_set returns false.

Return type:void
set_range()

Set range for double-valued parameter

Parameters:
  • min_value (double) – (double)
  • max_value (double) – (double)
Return type:

void

str()

Return short string description.

Return type:std::string
thisown

The membership flag

type_str()

Return value type string.

Return type:std::string
value()
value_str()

Return value string.

Return type:std::string
warn_once(msg)