File: input_formats.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 (65 lines) | stat: -rw-r--r-- 1,505 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
=============
Input Formats
=============

This module is used as a base for parsing input files.

The main class is :class:`formats.Parser`.

Each input format module has a child class named *FormatParser(Parser)*.

Classes
=======

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

Constants
=========

* .. data:: BUILTIN_INPUT_FORMATS

        Dictionnary that holds all input formats available in Total Open Station.

        Form of the dictionnary :
        
        { |br|
        'parser_name': ('module_parser_name', 'FormatParser', 'Parser Name'), |br|
        }

* .. data:: UNITS_CIRCLE

        Dictionnary that holds angle corresponding to the complet ride of a
        circle per units.

        Form of the dictionnary :

            { |br|
            'name': numeric value of complet ride, |br|
            }

* .. data:: UNKNOWN_STATION

        :class:`formats.Point` that holds arbitary coordinates of an unknown station. |br|
        These coordinates are not egals to zero to avoid negativ coordinates during
        computation.

        Point(10000, 10000, 100)

* .. data:: UNKNOWN_POINT

        :class:`formats.Point` that holds arbitary coordinates of an unknown point. |br|
        These coordinates are negatives to be able to check them during computation.

        Point(-1, -1, -1)

* .. data:: COORDINATE_ORDER

        tuple that holds possible coordinates order in some input formats.

        ('NEZ', 'ENZ')