schemata/CIM14/IEC61968/Common/StreetDetail.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.Element import Element
  18
  19 class StreetDetail(Element):
  20     """Street details, in the context of address.
  21     """
  22
  23     def __init__(self, number='', type='', suiteNumber='', addressGeneral='', buildingName='', name='', withinTownLimits=False, suffix='', code='', prefix='', *args, **kw_args):
  24         """Initialises a new 'StreetDetail' instance.
  25
  26         @param number: Designator of the specific location on the street.
  27         @param type: Type of street. Examples include: street, circle, boulevard, avenue, road, drive, etc.
  28         @param suiteNumber: Number of the apartment or suite.
  29         @param addressGeneral: Additional address information, for example a mailstop.
  30         @param buildingName: (if applicable) In certain cases the physical location of the place of interest does not have a direct point of entry from the street, but may be located inside a larger structure such as a building, complex, office block, apartment, etc.
  31         @param name: Name of the street.
  32         @param withinTownLimits: True if this street is within the legal geographical boundaries of the specified town (default).
  33         @param suffix: Suffix to the street name. For example: North, South, East, West.
  34         @param code: (if applicable) Utilities often make use of external reference systems, such as those of the town-planner's department or surveyor general's mapping system, that allocate global reference codes to streets.
  35         @param prefix: Prefix to the street name. For example: North, South, East, West.
  36         """
  37         #: Designator of the specific location on the street.
  38         self.number = number
  39
  40         #: Type of street. Examples include: street, circle, boulevard, avenue, road, drive, etc.
  41         self.type = type
  42
  43         #: Number of the apartment or suite.
  44         self.suiteNumber = suiteNumber
  45
  46         #: Additional address information, for example a mailstop.
  47         self.addressGeneral = addressGeneral
  48
  49         #: (if applicable) In certain cases the physical location of the place of interest does not have a direct point of entry from the street, but may be located inside a larger structure such as a building, complex, office block, apartment, etc.
  50         self.buildingName = buildingName
  51
  52         #: Name of the street.
  53         self.name = name
  54
  55         #: True if this street is within the legal geographical boundaries of the specified town (default).
  56         self.withinTownLimits = withinTownLimits
  57
  58         #: Suffix to the street name. For example: North, South, East, West.
  59         self.suffix = suffix
  60
  61         #: (if applicable) Utilities often make use of external reference systems, such as those of the town-planner's department or surveyor general's mapping system, that allocate global reference codes to streets.
  62         self.code = code
  63
  64         #: Prefix to the street name. For example: North, South, East, West.
  65         self.prefix = prefix
  66
  67         super(StreetDetail, self).__init__(*args, **kw_args)
  68
  69     _attrs = ["number", "type", "suiteNumber", "addressGeneral", "buildingName", "name", "withinTownLimits", "suffix", "code", "prefix"]
  70     _attr_types = {"number": str, "type": str, "suiteNumber": str, "addressGeneral": str, "buildingName": str, "name": str, "withinTownLimits": bool, "suffix": str, "code": str, "prefix": str}
  71     _defaults = {"number": '', "type": '', "suiteNumber": '', "addressGeneral": '', "buildingName": '', "name": '', "withinTownLimits": False, "suffix": '', "code": '', "prefix": ''}
  72     _enums = {}
  73     _refs = []
  74     _many_refs = []
  75