Markus Zolliker
0d265b9752
'Done' was introduced in order to suppress unneccessary duplicate updates. However, since super calls on access methods are allowed, it is not nice when such a method returns Done, as this is not automagically replaced by the current parameter value. As a consequence: - using Done is discouraged, but not (yet) removed in all code - the 'omit_unchanged_within' property is moved from Module to an internal Parameter property 'update_unchanged' - its default is moved from a SEC node property to generalConfig - the 'update_unchanged' parameter property may be set to 'never' for parameters where duplicate updates make no sense - this property might be set to 'always', for measurements, where even unchanged values taken from HW should be transmitted Change-Id: I2847c983ca09c2c4098e402edd08d0c96c3913f4 Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/30672 Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de> Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
143 lines
2.8 KiB
ReStructuredText
143 lines
2.8 KiB
ReStructuredText
Reference
|
|
---------
|
|
|
|
Core
|
|
....
|
|
|
|
For convenience everything documented on this page may also be
|
|
imported from the frappy.core module.
|
|
|
|
|
|
Module Base Classes
|
|
...................
|
|
|
|
.. autoclass:: frappy.modules.Module
|
|
:members: earlyInit, initModule, startModule
|
|
|
|
.. autoclass:: frappy.modules.Readable
|
|
:members: Status
|
|
|
|
.. autoclass:: frappy.modules.Writable
|
|
|
|
.. autoclass:: frappy.modules.Drivable
|
|
:members: Status, isBusy, isDriving, stop
|
|
|
|
|
|
Parameters, Commands and Properties
|
|
...................................
|
|
|
|
.. autoclass:: frappy.params.Parameter
|
|
.. autoclass:: frappy.params.Command
|
|
.. autoclass:: frappy.properties.Property
|
|
.. autoclass:: frappy.modules.Attached
|
|
:show-inheritance:
|
|
|
|
Access method decorators
|
|
........................
|
|
|
|
.. autofunction:: frappy.rwhandler.nopoll
|
|
|
|
|
|
.. _datatypes:
|
|
|
|
Datatypes
|
|
.........
|
|
|
|
.. autoclass:: frappy.datatypes.FloatRange
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.IntRange
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.BoolType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.ScaledInteger
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.EnumType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.StringType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.TupleOf
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.ArrayOf
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.StructOf
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.BLOBType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.DataTypeType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.ValueType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.NoneOr
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.OrType
|
|
:members: __call__
|
|
|
|
.. autoclass:: frappy.datatypes.LimitsType
|
|
:members: __call__
|
|
|
|
|
|
Communication
|
|
.............
|
|
|
|
.. autoclass:: frappy.modules.Communicator
|
|
:show-inheritance:
|
|
:members: communicate
|
|
|
|
.. autoclass:: frappy.io.IOBase
|
|
:show-inheritance:
|
|
:members: default_settings
|
|
|
|
.. autoclass:: frappy.io.StringIO
|
|
:show-inheritance:
|
|
:members: communicate, multicomm
|
|
|
|
.. autoclass:: frappy.io.BytesIO
|
|
:show-inheritance:
|
|
:members: communicate, multicomm
|
|
|
|
.. autoclass:: frappy.io.HasIO
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: frappy.lib.asynconn.AsynTcp
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: frappy.lib.asynconn.AsynSerial
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: frappy.rwhandler.ReadHandler
|
|
:show-inheritance:
|
|
:members:
|
|
|
|
.. autoclass:: frappy.rwhandler.CommonReadHandler
|
|
:show-inheritance:
|
|
:members:
|
|
|
|
.. autoclass:: frappy.rwhandler.WriteHandler
|
|
:show-inheritance:
|
|
:members:
|
|
|
|
.. autoclass:: frappy.rwhandler.CommonWriteHandler
|
|
:show-inheritance:
|
|
:members:
|
|
|
|
|
|
Exception classes
|
|
.................
|
|
|
|
.. automodule:: frappy.errors
|
|
:members:
|
|
|
|
.. include:: configuration.rst |