Files
frappy/doc/source/reference.rst
Markus Zolliker 0d265b9752 make return value 'Done' unneccessary
'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>
2023-04-21 16:17:30 +02:00

2.8 KiB

Reference

Core

For convenience everything documented on this page may also be imported from the frappy.core module.

Module Base Classes

frappy.modules.Module

frappy.modules.Readable

frappy.modules.Writable

frappy.modules.Drivable

Parameters, Commands and Properties

frappy.params.Parameter

frappy.params.Command

frappy.properties.Property

frappy.modules.Attached

Access method decorators

frappy.rwhandler.nopoll

Datatypes

frappy.datatypes.FloatRange

frappy.datatypes.IntRange

frappy.datatypes.BoolType

frappy.datatypes.ScaledInteger

frappy.datatypes.EnumType

frappy.datatypes.StringType

frappy.datatypes.TupleOf

frappy.datatypes.ArrayOf

frappy.datatypes.StructOf

frappy.datatypes.BLOBType

frappy.datatypes.DataTypeType

frappy.datatypes.ValueType

frappy.datatypes.NoneOr

frappy.datatypes.OrType

frappy.datatypes.LimitsType

Communication

frappy.modules.Communicator

frappy.io.IOBase

frappy.io.StringIO

frappy.io.BytesIO

frappy.io.HasIO

frappy.lib.asynconn.AsynTcp

frappy.lib.asynconn.AsynSerial

frappy.rwhandler.ReadHandler

frappy.rwhandler.CommonReadHandler

frappy.rwhandler.WriteHandler

frappy.rwhandler.CommonWriteHandler

Exception classes

frappy.errors