File: SurfaceData.py

package info (click to toggle)
esys-particle 2.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 7,284 kB
  • sloc: cpp: 77,304; python: 5,647; makefile: 1,176; sh: 10
file content (49 lines) | stat: -rw-r--r-- 1,913 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
#############################################################
##                                                         ##
## Copyright (c) 2003-2011 by The University of Queensland ##
## Earth Systems Science Computational Centre (ESSCC)      ##
## http://www.uq.edu.au/esscc                              ##
##                                                         ##
## Primary Business: Brisbane, Queensland, Australia       ##
## Licensed under the Open Software License version 3.0    ##
## http://www.opensource.org/licenses/osl-3.0.php          ##
##                                                         ##
#############################################################

"""
Defines the L{SurfaceData} class.
"""
from PointExtractor import PointExtractor
class SurfaceData(object):
    """
    Represents a topographic surface.
    """
    def __init__(self, data, pointExtractor):
        """
        Constructs the object.
        @type data: iterable
        @param data: Object containing data which specifies discrete points
        on a surface.
        @type pointExtractor: L{PointExtractor}
        @param pointExtractor: An object to extract surface coordinates
          from the specified C{data}.
        """
        self.data           = data
        self.pointExtractor = pointExtractor

    def getData(self):
        """
        Returns the I{iterable} data associated with this C{SurfaceData} object.
        @rtype: object
        @return: The I{iterable} object which contains the surface coordinates.
        """
        return self.data

    def getPointExtractor(self):
        """
        Returns the I{extractor} object used to obtain points from
        the data-records contained in the C{self.getData()} iterable.
        @rtype: L{PointExtractor}
        @return: L{PointExtractor} object used to obtain surface data points.
        """
        return self.pointExtractor