InternalState

class mlfmu.types.fmu_component.InternalState(*, name: str | None = None, description: str | None = None, startValue: float | None = None, initializationVariable: str | None = None, agentOutputIndexes: list[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=True, to_upper=True, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^(\d+|\d+:\d+)$)]] = [])

Bases: BaseModelConfig

Pydantic model representing an internal state of an FMU component.

__init__(**data: Any) → None

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.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
check_only_one_initialization()	Check if only one state initialization method is used at a time.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy
model_dump(*[, mode, include, exclude, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump
model_dump_json(*[, indent, include, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(_BaseModel__context)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/json/#json-parsing
model_validate_strings(obj, *[, strict, context])	Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
update_forward_refs(**localns)
validate(value)

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
name	Unique name for the state.
description	Short description of the FMU variable.
start_value	The default value of the parameter used for initialization.
initialization_variable	The name of an input or parameter in the same model interface that should be used to initialize this state.
agent_output_indexes	Index or range of indices of agent (ONNX model) outputs that will be stored as internal states and will be fed as inputs in the next time step.

check_only_one_initialization() → InternalState

Check if only one state initialization method is used at a time.

Raises a ValueError if multiple state initialization methods are used simultaneously.

Returns:

self

Return type:

The FMU component instance.

Raises:

• ValueError – If initialization_variable is set and either start_value or name is also set.:

• ValueError – If name is set without start_value being set.:

• ValueError – If start_value is set without name being set.:

agent_output_indexes: list[Annotated[str, StringConstraints(strip_whitespace=True, to_upper=True, pattern='^(\\d+|\\d+:\\d+)$')]]

Index or range of indices of agent (ONNX model) outputs that will be stored as internal states and will be fed as inputs in the next time step. Note: the FMU signal and the ONNX (agent) outputs need to have the same length. Defaults to an empty list.

description: str | None

Short description of the FMU variable. Optional.

initialization_variable: str | None

The name of an input or parameter in the same model interface that should be used to initialize this state. Optional.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

Unique name for the state. Only needed if start_value is set (!= None). Initialization FMU parameters will be generated using this name. Optional.

start_value: float | None

The default value of the parameter used for initialization. If this field is set, parameters for initialization will be automatically generated for these states. Optional.