File: class.rst

package info (click to toggle)
cf-python 1.3.2+dfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: sid, stretch
  • size: 7,996 kB
  • sloc: python: 51,733; ansic: 2,736; makefile: 78; sh: 2
file content (99 lines) | stat: -rw-r--r-- 1,825 bytes parent folder | download
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
.. currentmodule:: cf
.. default-role:: obj

.. _class:

Classes of the :mod:`cf` module
===============================

Field classes
-------------

.. autosummary::
   :nosignatures:
   :toctree: classes/

   cf.Field		              
   cf.FieldList		              

Field component classes
-----------------------

.. autosummary::
   :nosignatures:
   :toctree: classes/

   cf.AuxiliaryCoordinate
   cf.CellMeasure
   cf.CellMethods
   cf.CoordinateBounds
   cf.CoordinateReference
   cf.Data
   cf.DimensionCoordinate
   cf.Domain
   cf.Flags
   cf.Units

Miscellaneous classes
---------------------

.. autosummary::
   :nosignatures:
   :toctree: classes/

   cf.Datetime
   cf.Query
   cf.TimeDuration

Base classes
------------

.. autosummary::
   :nosignatures:
   :toctree: classes/
         
   cf.Coordinate
   cf.Dict       
   cf.Variable       

.. _inheritance_diagrams:

Inheritance diagrams
--------------------

The classes defined by the `cf` package inherit as follows:

----

.. image:: images/inheritance1.png

.. commented out
   .. inheritance-diagram:: cf.Domain
                            cf.Data
                            cf.Flags	
                            cf.Units
                            cf.Datetime
                            cf.TimeDuration
                            cf.Query
      :parts: 1

----

.. image:: images/inheritance2.png

.. commented out
   .. inheritance-diagram:: cf.CoordinateBounds
                            cf.AuxiliaryCoordinate
                            cf.DimensionCoordinate
                            cf.FieldList
                            cf.CellMeasure
         :parts: 1

----

.. image:: images/inheritance3.png

.. commented out
  .. inheritance-diagram:: cf.CellMethods
                           cf.CoordinateReference
         :parts: 1