Skip to content
Snippets Groups Projects
Commit 8135a4e0 authored by Stefano Borini's avatar Stefano Borini
Browse files

Fixed documentation

parent 63e2980e
No related branches found
No related tags found
1 merge request!76Adds change_slots event to notify UI of slot-modifying changes
......@@ -13,14 +13,16 @@ To implement a new plugin, you must
- define the entity you want to extend (e.g. ``MyOwnDataSource``) as a derived
class of the appropriate class (e.g. ``BaseDataSource``), and reimplement
the appropriate methods:
- ``run()``: where the actual computation takes place, given the
configuration options specified in the model (which is received as an
argument). It is strongly advised that the ``run()`` method is stateless.
- ``slots()``: must return a 2-tuple of tuples. Each tuple contains instances
of the ``Slot`` class. Slots are the input and output entities of the
data source or KPI calculator. Given that this information depends on the
configuration options, ``slots()`` accepts the model and must return the
appropriate values according to the model options.
- ``run()``: where the actual computation takes place, given the
configuration options specified in the model (which is received as an
argument). It is strongly advised that the ``run()`` method is stateless.
- ``slots()``: must return a 2-tuple of tuples. Each tuple contains instances
of the ``Slot`` class. Slots are the input and output entities of the
data source or KPI calculator. Given that this information depends on the
configuration options, ``slots()`` accepts the model and must return the
appropriate values according to the model options.
- Define the model that this ``DataSource`` needs, by extending
``BaseDataSourceModel`` and adding, with traits, the appropriate data that
are required by your data source to perform its task.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment