[Py] BlockParameter

class opalone._internal.block_parameters.BlockParameter(parameter_id, model_id, project_id, data_type, path)

Bases: Parameter

A block parameter is a parameter that is owned by a Block.

connect_to(datapoint, is_enabled=True, force_enable=False)

Connect the current datapoint to another datapoint.

If the connection to create is enabled, i.e. is_enabled=True, and any datapoint in this new connection is actively connected to another datapoint, then some connection rules will apply and the new connection might be declared invalid. If force_enable=True, conflicting connections will be disabled in favor of the new connection.

Some data types are incompatibles between one another, so that might result in an invalid connection. For example, a STRING data type cannot connect to a NUMERIC data type.

If the backend reports the connection to be invalid, this method will attempt to connect the other way around. For example, if A.connect_to(B) fails on the backend, this method will attempt the equivalent of B.connect_to(A). If this connection also fails, the first failure will be reported to the user.

delete()

Delete the current parameter.

This function does nothing for now, since a parameter deletion is not supported. To delete a parameter, the user must delete the Block or Widget owning this parameter.

reset_to_default_value()

Reset a value to its default.

The default value is, generally, the value of the parameter as defined in the model containing this parameter. In particular, the default value is not a member of any ParameterSet.

to_json(fields, values)

Convert this resource to a serialized JSON representation.

property connections: tuple[Connection]

The connections going to this datapoint.

A connection allows describing a transfer of data between two datapoints.

property data_type: DataType

The data type of the datapoint.

This property is read-only, it cannot be modified.

property default_value: bool | str | float | dict

The default value of this datapoint.

The default value’s type is determined at runtime and depends on the Data type of the datapoint.

This property is read-only, it cannot be modified.

property id: str

The ID of the resource.

This property is read-only, it cannot be modified.

property is_displayed_on_canvas: bool

Indicates if this datapoint is displayed on canvas (True) or not (False). If True, the datapoint and its value are displayed on the UI next to the block.

property is_equal_mode: bool

Indicates in this parameter has equal mode enabled (True) or not (False). The equal mode applies only on non-scalar values. When active, all indices of the non-scalar value are forced equal. A change for any index will also update all other indices to the same value.

property is_favorite: bool

Indicates if this datapoint is a favorite (True) or not (False). If True, the datapoint is displayed in the favorite section in the UI.

property is_read_only: bool

Indicates if this parameter is read-only (True) or not (False). A read-only parameter is a parameter for which its value cannot be modified.

This property itself is read-only, it cannot be modified.

property is_tunable: bool

Indicates if this parameter is tunable (True) or not (False). A tunable parameter is a parameter for which its value can be modified while a simulation is running.

This property is read-only, it cannot be modified.

property is_visible: bool

Indicates if this datapoint is visible (True) or not (False).

This property is read-only, it cannot be modified.

property name: str

The name of the datapoint.

This property is read-only, it cannot be modified.

property path: str

Path of a Datapoint in the model, seperated with “/”

property ref_id: str

The reference ID of the datapoint.

This ID is only useful to lookup the datapoint’s library data.

This property is read-only, it cannot be modified.

property size: tuple[int]

Array of values describing the size of multidimensional datapoints. Equals to (1) for scalars, (1, N) for row vectors, (M, 1) for column vectors, (M, N) for matrices and (D1, D2…, Dn) more generally.

This property is read-only, it cannot be modified.

property type: DatapointType

The type of the datapoint.

This property is read-only, it cannot be modified.

property unit: str

The units of the datapoint.

Example units: Volts, Amperes, seconds, etc.

This property is read-only, it cannot be modified.

property value: object

The current value for this parameter.

The value’s type is determined at runtime and depends on the Data type of the datapoint.