CADETProcess.dataStructure.parameter.ParameterBase

CADETProcess.dataStructure.parameter.ParameterBase#

class CADETProcess.dataStructure.parameter.ParameterBase(*args: Any, default: Any | None = None, is_optional: bool = False, unit: str | None = None, description: str | None = None, **kwargs: Any)[source]#

Bases: Descriptor

Base class for model parameters with potential constraints or type-casting.

Unlike mere data members, parameters can have default values, support type constraints, and cast from certain types to their target type.

Attributes:
defaultAny

Any: Get or set the default value of the parameter.

unitstr

Unit of the parameter.

descriptionstr

Description or context of the parameter.

See also

Descriptor
Structure
Constant
Switch
Typed
Bool
Integer
Tuple
Float
String
Dictionary

Notes

  1. Supports deep copying of default values, allowing mutable defaults without side effects.

  2. Subclasses can further specify type constraints (like Typed).

  3. They can also define

  • immutable parameters (like Constant) and

  • options-based parameters (Switch).

property default: Any#

Any: Get or set the default value of the parameter.

get_default_value(instance: Any) → Any[source]#

Return default values if necessary.

Override this method if type-casting for default values is necessary.

Parameters:
instanceAny

Instance to retrieve the default value for.

Returns:
Any

Default value.