Documentation Home Page OPAL-RT Dashboard Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

[Py] Class reference


This section of the documentation gives details on each class definition that can be manipulated by the user. Usually, instances of such classes are returned by the various functions of the API.

opalone._internal.projects.Project(project_id)

A project is a resource which contains an arbitrary number of Models, Boards, ParameterSets, Connections and other types of resources.

opalone._internal.models.Model(model_id[, ...])

A model is a resource which contains diagram information that can be edited with Schematic Editor, Simulink or HYPERSIM.

opalone._internal.levels.Level(level_id, ...)

A level is a component of a Model gathering other levels and Blocks.

opalone._internal.blocks.Block(block_id, ...)

A block is a component of a model.

opalone._internal.subsystems.Subsystem(...)

A subsystem is a special Block that contains other blocks inside itself.

opalone._internal.block_parameters.BlockParameter(...)

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

opalone._internal.block_signals.BlockSignal(...)

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

opalone._internal.ports.Port(port_id[, ...])

A port is a part of a Block which allows interconnecting multiple blocks together.

opalone._internal.links.Link(link_id[, model_id])

A link is a visual relationship between two block Ports.

opalone._internal.boards.Board(board_id, ...)

Base class for all boards.

opalone._internal.board_locator.BoardLocator(...)

A dict-like class that handles subscriptions to fetch boards within a project.

opalone._internal.boards.Table(table_id, ...)

A table is a custom list of data points of interest which belong to the same project.

opalone._internal.boards.Panel(panel_id, ...)

A panel is a graphical canvas of Widgets, that the user can arrange and customize.

opalone._internal.boards.Group(group_id, ...)

A group allows to group boards together.

opalone._internal.widgets.Widget(widget_id, ...)

A widget is a component of a panel that is used to control values in the simulation and display values from it.

opalone._internal.widget_parameters.WidgetParameter(...)

A widget parameter is a parameter that is owned by a Widget.

opalone._internal.widget_signals.WidgetSignal(...)

A widget signal is a signal that is owned by a Widget.

opalone._internal.connections.Connection(...)

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

opalone._internal.files.File(file_id[, ...])

A File representation stored in the backend server.

opalone._internal.parameter_sets.ParameterSet(...)

A parameter set gathers different values of a configurable set of parameters.

opalone._internal.data.Data(datapoint_id, ...)

Base class for various data value holders.

opalone._internal.datapoints.Datapoint(...)

Base class for all datapoints.

opalone._internal.library_block.LibraryBlock(id, ...)

Base class for all kind of resource object.

opalone._internal.scripts.Script(script_id, ...)

A Script representation stored in the backend server.

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323