Markus Zolliker
bc33933a1a
- add properties, parameters and commands to the doc string autoatically - change names to "Frappy" - started tutorial - changed doc structure slightly Change-Id: I87bef91384d138c738d12ddcf3a1de7f758a0973
68 lines
1.3 KiB
ReStructuredText
68 lines
1.3 KiB
ReStructuredText
Framework documentation
|
|
=======================
|
|
|
|
|
|
Module Base Classes
|
|
-------------------
|
|
|
|
.. autoclass:: secop.core.Module
|
|
:members: startModule
|
|
|
|
.. autoclass:: secop.core.Readable
|
|
:members: pollerClass, Status
|
|
|
|
.. autoclass:: secop.core.Writable
|
|
|
|
.. autoclass:: secop.core.Drivable
|
|
:members: Status, isBusy, isDriving, do_stop
|
|
|
|
|
|
Parameters, Commands and Properties
|
|
-----------------------------------
|
|
|
|
.. autoclass:: secop.core.Parameter
|
|
.. autoclass:: secop.core.Command
|
|
.. autoclass:: secop.core.Override
|
|
.. autoclass:: secop.core.Property
|
|
.. autoclass:: secop.core.Attached
|
|
|
|
|
|
Datatypes
|
|
---------
|
|
|
|
.. autoclass:: secop.core.FloatRange
|
|
.. autoclass:: secop.core.IntRange
|
|
.. autoclass:: secop.core.BoolType
|
|
.. autoclass:: secop.core.ScaledInteger
|
|
.. autoclass:: secop.core.EnumType
|
|
.. autoclass:: secop.core.StringType
|
|
.. autoclass:: secop.core.TupleOf
|
|
.. autoclass:: secop.core.ArrayOf
|
|
.. autoclass:: secop.core.StructOf
|
|
.. autoclass:: secop.core.BLOBType
|
|
|
|
|
|
Communication
|
|
-------------
|
|
|
|
.. autoclass:: secop.core.Communicator
|
|
:members: do_communicate
|
|
|
|
.. autoclass:: secop.core.StringIO
|
|
:members: do_communicate, do_multicomm
|
|
|
|
.. autoclass:: secop.core.HasIodev
|
|
|
|
.. autoclass:: secop.core.IOHandlerBase
|
|
:members:
|
|
|
|
.. autoclass:: secop.core.IOHandler
|
|
:members:
|
|
|
|
|
|
Exception classes
|
|
-----------------
|
|
|
|
.. automodule:: secop.errors
|
|
:members:
|