System¶

class ospx.system.System(properties: MutableMapping[Any, Any])¶

Bases: object

The system structure describes the topology of the co-simulated system.

A system structure can contain an arbitrary number of components. Components can be connected through connections. Connections relate a source endpoint with a target endpoint. Both component variables and component connectors can be used as endpoints in a connection.

__init__(properties: MutableMapping[Any, Any]) → None¶

Methods

__init__(properties)

Attributes

`components`	Return a dict with all components contained in the system.
`connections`	Return a dict with all connections defined in the system.
`connectors`	Return a combined dict with all connectors from all components contained in the system.
`fmus`	Return a dict with all FMUs referenced by components contained in the system.
`units`	Return a combined dict with all units from all components contained in the system.
`variables`	Return a combined dict with all scalar variables from all components contained in the system.

property components: dict[str, Component]¶

Return a dict with all components contained in the system.

Returns:: dict with all components
Return type:: dict[str, Component]

property connections: dict[str, Connection]¶

Return a dict with all connections defined in the system.

Returns:: dict with all connections
Return type:: dict[str, Connection]

property connectors: dict[str, Connector]¶

Return a combined dict with all connectors from all components contained in the system.

Returns:: dict with all connectors from all components
Return type:: dict[str, Connector]

property fmus: dict[str, FMU]¶

Return a dict with all FMUs referenced by components contained in the system.

Returns:: dict with all FMUs
Return type:: dict[str, FMU]

property units: dict[str, Unit]¶

Return a combined dict with all units from all components contained in the system.

Returns:: dict with all units from all components
Return type:: dict[str, Unit]

property variables: dict[str, ScalarVariable]¶

Return a combined dict with all scalar variables from all components contained in the system.

Returns:: dict with all scalar variables from all components
Return type:: dict[str, ScalarVariable]