search

PyMoDAQ / pymodaq_plugins_template

Template fro PyMoDAQ's plugin packaging
MIT License
3 stars 29 forks source link

Documentation on DAQ_move #13

Open ddennetiere opened 3 months ago

ddennetiere commented 3 months ago

Dear PyMoDAQers, There is an incoherence in the documentation online : the chapter 8.1.5 on DAQ_Move "the useful entry and output points that you may use in your applications", yet the plugin template repository for DAQ_move_plugins inherits DAQ_Move_base and not DAQ_move. Some of the entries in the doc (like get_continuous_actuator_value) don't exists as methods of DAQ_Move_base.

Which is it ? Should we inherit from DAQ_Move or DAQ_move_base ?

Cheers, David

seb5g commented 3 months ago

Your application (not your instrument plugin) will instantiate DAQ_Move as a part of the GUI. This guy has of course an API (that may look like the ones in a plugin) with entrypoints.

The instrument plugin class (that will be instantiated by the DAQ_Move) inherits from DAQ_Move_base whose role is to smooth out of your class all the complexity of the communication from your plugin to the GUI and inversely. The plugin focus on communicating with the instrument.

Then the app template class (or the extension template class) is here to help you construct application on the GUI level.