GeneratedValueDefinition

class ase2sprkkr.common.generated_configuration_definitions.GeneratedValueDefinition(name, getter, setter=None, written_name=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, name_in_grammar=None, name_format=None, info=None, description=None, name_regex=None, condition=None, write_condition=None, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=None, warning_condition=None, validators=(), plot=None, indent=None)[source]

Definition of a value computed from its runtime section.

getter receives (section) for ordinary access and (section, key) for indexed access. setter, when supplied, receives (section, value) or (section, value, key). A setter that needs the active transaction can obtain it using ConfigurationTransaction.current().

Class hierarchy

Inheritance diagram of ase2sprkkr.common.generated_configuration_definitions.GeneratedValueDefinition


Constructor

Parameters:
  • name (str)

  • getter (Callable[[...], Any])

  • setter (Callable[[...], None] | None)

  • warning_condition (Callable[[Any], Any] | None)

  • validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

__init__(name, getter, setter=None, written_name=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, name_in_grammar=None, name_format=None, info=None, description=None, name_regex=None, condition=None, write_condition=None, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=None, warning_condition=None, validators=(), plot=None, indent=None)[source]

Define name using its runtime getter and optional setter.

Parameters:
  • name (str)

  • getter (Callable[[...], Any])

  • setter (Callable[[...], None] | None)

  • warning_condition (Callable[[Any], Any] | None)

  • validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

Return type:

None

property setter