State dataclass

State(
    time_step: int,
    uncontrolled_power_balance: float,
    uncontrolled_power_contribution_per_component: dict[
        str, float
    ],
    components_states: dict,
    date_time: Timestamp,
)

Describes the state of the EnergySystem.

It is generated in each simulation time step and used by the controllers as decision criteria. Later, the information from the state per time step is available in the simulation results.

The state contains:

• Information about the time step and datetime of the state.
• Information about the state of all components of the EnergySystem which implement PublishesStateMixin interface. The state of the components is published by their implementation of get_state().
• Information about the uncontrolled power contribution of a component. An uncontrolled power contribution happens no matter how the system is controlled. For example by a load or a pv component. Components implementing ContributesToPowerBalanceMixin provide this information.