Versions Compared

Old Version 2

changes.mady.by.user Louis-Philippe Bell

Saved on

compared with

New Version Current

changes.mady.by.user Louis-Philippe Bell

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint
opalone._internal.datapoints.Datapoint
class opalone._internal.datapoints.Datapoint(datapoint_id, project_id, datapoint_type, data_type, path)
Panel
bgColorunset

Bases: Resource, ABC

Base class for all datapoints. Cannot be instantiated, must use subclass.

A data point is an element contained in an entity, for example, a Model, which can be probed and have its value set by or sent to another simulation component.

Parameters:

  • datapoint_id (str) – The ID of the datapoint.

  • project_id (str) – The ID of the Project that owns the datapoint.

  • datapoint_type (str | DatapointType) – The type of datapoint.

  • data_type (Data) – A data value holder.

Raises:

TypeError – If the data value holder is not of the correct type.

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.connect_to
opalone._internal.datapoints.Datapoint.connect_to
connect_to(datapoint, is_enabled=True, force_enable=False)
Panel
bgColorunset

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.

Parameters:

  • datapoint (str | Datapoint) – The datapoint to connect to, either an ID or a datapoint object..

  • is_enabled (bool) – A flag to enable (True) or disable (False) the connection to create.

  • force_enable (bool) – A flag to drop (True) or not (False) any conflicting connections that already exist in the system.

Returns:

A new connection instance

Return type:

Connection

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.delete
opalone._internal.datapoints.Datapoint.delete
delete()
Panel
bgColorunset

Delete the current resource, which is done by suppressing its ID.

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.to_json
opalone._internal.datapoints.Datapoint.to_json
to_json(fields, values)
Panel
bgColorunset

Convert this resource to a serialized JSON representation.

Parameters:

  • fields (tuple[str] | list[str]) – Fields to include.

  • values (tuple[object] | list[object]) – The value of each field

Returns:

The serialized JSON representation.

Return type:

str

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.alias
opalone._internal.datapoints.Datapoint.alias
property alias: str
Panel
bgColorunset

Get the alias of the datapoint.

This property returns an AliasWrapper, which behaves like a string but also provides additional methods like generate(). If the alias is not set, it initializes with an empty AliasWrapper.

Returns:

The alias of the datapoint.

Return type:

AliasWrapper | None

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.connections
opalone._internal.datapoints.Datapoint.connections
property connections: tuple[Connection]
Panel
bgColorunset

The connections going to this datapoint.

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.data_type
opalone._internal.datapoints.Datapoint.data_type
property data_type: DataType
Panel
bgColorunset

The data type of the datapoint.

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.default_value
opalone._internal.datapoints.Datapoint.default_value
property default_value: bool | str | float | dict
Panel
bgColorunset

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.

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.id
opalone._internal.datapoints.Datapoint.id
property id: str
Panel
bgColorunset

The ID of the resource.

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.is_displayed_on_canvas
opalone._internal.datapoints.Datapoint.is_displayed_on_canvas
property is_displayed_on_canvas: bool
Panel
bgColorunset

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.

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.is_favorite
opalone._internal.datapoints.Datapoint.is_favorite
property is_favorite: bool
Panel
bgColorunset

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.is_visible
opalone._internal.datapoints.Datapoint.is_visible
property is_visible: bool
Panel
bgColorunset

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

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.name
opalone._internal.datapoints.Datapoint.name
property name: str
Panel
bgColorunset

The name of the datapoint.

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.path
opalone._internal.datapoints.Datapoint.path
property path: str
Panel
bgColorunset

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.ref_id
opalone._internal.datapoints.Datapoint.ref_id
property ref_id: str
Panel
bgColorunset

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.

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.size
opalone._internal.datapoints.Datapoint.size
property size: tuple[int]
Panel
bgColorunset

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.

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.type
opalone._internal.datapoints.Datapoint.type
property type: DatapointType
Panel
bgColorunset

The type of the datapoint.

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.unit
opalone._internal.datapoints.Datapoint.unit
property unit: str
Panel
bgColorunset

The units of the datapoint.

Example units: Volts, Amperes, seconds, etc.

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

Panel
bgColorunset
Anchor
opalone._internal.datapoints.Datapoint.value
opalone._internal.datapoints.Datapoint.value
abstract property value: object
Panel
bgColorunset

The current value for this parameter.

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