Setting#

class Setting(parameter=None, value=None, read_only=False, path='')#

Physical quantity represented as a Parameter attached to a numerical value.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

`element_indices`	Element-wise indices of the parameter in `self`.
`label`	Label used as pretty identifier for display purposes, same as label of `parameter`.
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`name`	Name used as identifier, same as name of `parameter`.
`parent_label`	Parent label of the parameter of `self`.
`parent_name`	Parent name of the parameter of `self`.
`unit`	SI unit of the `value`, if applicable, same as unit of `parameter`.
`parameter`	The parameter this Setting represents.
`value`	Data value attached to the parameter.
`read_only`	Indicates if the attribute is read-only.
`path`	Path in the settings tree (starting from the root `SettingNode`) for this setting.

Methods

`create_element_parameter_for`	Utility for creating an element-wise parameter for a single value in a collection valued parameter.
`diff_sets`	Return a one-sided difference between two sets of Settings, prioritising values in first.
`get_by_name`
`merge`
`remove_by_name`
`replace`
`update`	Create a new setting object with updated value.
`validate_parameter_value_after`
`with_path_name`	Copy of self with the parameter name replaced by the path name.

Parameters:

path: str#: Path in the settings tree (starting from the root SettingNode) for this setting.

update(value)#

Create a new setting object with updated value.

Parameters:: value (bool | str | int | float | complex | ndarray) –
Return type:: Setting

property label#: Label used as pretty identifier for display purposes, same as label of parameter.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'frozen': True, 'ser_json_inf_nan': 'constants', 'validate_assignment': True, 'validate_default': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property unit#: SI unit of the value, if applicable, same as unit of parameter.

property element_indices: tuple[int, ...] | None#: Element-wise indices of the parameter in self.

static diff_sets(first, second)#

Return a one-sided difference between two sets of Settings, prioritising values in first.

Parameters:

Returns:

A new set of Settings whose parameters are only found in first, and Settings in first whose values differ from their counterparts in second.

Return type:

set[Setting]

create_element_parameter_for(indices)#

Utility for creating an element-wise parameter for a single value in a collection valued parameter.

Parameters:: indices (int | list[int]) – The indices in the collection for which to create the element-wise parameter.
Returns:: The element-wise parameter.
Raises:: ValueError – If self is not collection-valued.
Return type:: Parameter

with_path_name()#

Copy of self with the parameter name replaced by the path name.

Setting