File: models.rst

package info (click to toggle)
totalopenstation 0.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,784 kB
  • sloc: python: 4,123; makefile: 84; xml: 50
file content (31 lines) | stat: -rw-r--r-- 582 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
======
Models
======

This module is used as a base for models submodules.

The main class is :class:`models.Connector`.

Each model module has a child class named *ModelConnector(Connector)*.

Classes
=======

.. automodule:: models
   :members:
   :member-order: bysource
   :undoc-members:
   :show-inheritance:

Constants
=========

* .. data:: BUILTIN_MODELS

    Dictionnary that holds all models available in Total Open Station.

    Form of the dictionnary :
    
    { |br|
    'model_name': ('module_name', 'ModelConnector' or 'CustomConnector', 'Model Name'), |br|
    }