Trees       Indices       Help   
PyCIM
Package CIM15 :: Package IEC61968 :: Package Common :: Module Location' :: Class Location
[hide private]
[frames] | no frames]

Class Location

                                  object --+        
                                           |        
                            Element'.Element --+    
                                               |    
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+
                                                   |
                                                  Location
Known Subclasses:

The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more postition points (coordinates) in a given coordinate system.The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more postition points (coordinates) in a given coordinate system.

Instance Methods [hide private]
 
__init__(self, category='', geoInfoReference='', corporateCode='', direction='', mainAddress=None, phone1=None, phone2=None, PowerSystemResources=None, secondaryAddress=None, ChangeItems=None, RedLines=None, DimensionsInfo=None, LandProperties=None, Assets=None, Hazards=None, status=None, Crews=None, PositionPoints=None, electronicAddress=None, Directions=None, Measurements=None, Routes=None, CoordinateSystem=None, ErpOrganisations=None, *args, **kw_args)
Initialises a new 'Location' instance.
 
addAssets(self, *Assets)
 
addChangeItems(self, *ChangeItems)
 
addCrews(self, *Crews)
 
addDirections(self, *Directions)
 
addErpOrganisations(self, *ErpOrganisations)
 
addHazards(self, *Hazards)
 
addLandProperties(self, *LandProperties)
 
addMeasurements(self, *Measurements)
 
addPositionPoints(self, *PositionPoints)
 
addPowerSystemResources(self, *PowerSystemResources)
 
addRedLines(self, *RedLines)
 
addRoutes(self, *Routes)
 
getAssets(self)
All assets at this location.
 
getChangeItems(self)
 
getCoordinateSystem(self)
Coordinate system used to describe position points of this location.
 
getCrews(self)
 
getDimensionsInfo(self)
 
getDirections(self)
 
getErpOrganisations(self)
 
getHazards(self)
 
getLandProperties(self)
 
getMeasurements(self)
 
getPositionPoints(self)
Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.
 
getPowerSystemResources(self)
All power system resources at this location.
 
getRedLines(self)
 
getRoutes(self)
 
removeAssets(self, *Assets)
 
removeChangeItems(self, *ChangeItems)
 
removeCrews(self, *Crews)
 
removeDirections(self, *Directions)
 
removeErpOrganisations(self, *ErpOrganisations)
 
removeHazards(self, *Hazards)
 
removeLandProperties(self, *LandProperties)
 
removeMeasurements(self, *Measurements)
 
removePositionPoints(self, *PositionPoints)
 
removePowerSystemResources(self, *PowerSystemResources)
 
removeRedLines(self, *RedLines)
 
removeRoutes(self, *Routes)
 
setAssets(self, value)
 
setChangeItems(self, value)
 
setCoordinateSystem(self, value)
 
setCrews(self, value)
 
setDimensionsInfo(self, value)
 
setDirections(self, value)
 
setErpOrganisations(self, value)
 
setHazards(self, value)
 
setLandProperties(self, value)
 
setMeasurements(self, value)
 
setPositionPoints(self, value)
 
setPowerSystemResources(self, value)
 
setRedLines(self, value)
 
setRoutes(self, value)

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'category': <type 'str'>, 'corporateCode': <typ...
  _attrs = ['category', 'geoInfoReference', 'corporateCode', 'di...
  _defaults = {'category': '', 'corporateCode': '', 'direction':...
  _many_refs = ['PowerSystemResources', 'ChangeItems', 'RedLines...
  _refs = ['mainAddress', 'phone1', 'phone2', 'PowerSystemResour...
  electronicAddress = None
  mainAddress = None
  phone1 = None
  phone2 = None
  secondaryAddress = None
  status = None

Inherited from Element'.Element (private): _enums

Properties [hide private]
  Assets
All assets at this location.
  ChangeItems
  CoordinateSystem
Coordinate system used to describe position points of this location.
  Crews
  DimensionsInfo
  Directions
  ErpOrganisations
  Hazards
  LandProperties
  Measurements
  PositionPoints
Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.
  PowerSystemResources
All power system resources at this location.
  RedLines
  Routes

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, category='', geoInfoReference='', corporateCode='', direction='', mainAddress=None, phone1=None, phone2=None, PowerSystemResources=None, secondaryAddress=None, ChangeItems=None, RedLines=None, DimensionsInfo=None, LandProperties=None, Assets=None, Hazards=None, status=None, Crews=None, PositionPoints=None, electronicAddress=None, Directions=None, Measurements=None, Routes=None, CoordinateSystem=None, ErpOrganisations=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Location' instance.

Parameters:
  • category - Category by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).
  • geoInfoReference - (if applicable) Reference to geographical information source, often external to the utility.
  • corporateCode - Utility-specific code for the location.
  • direction - (if applicable) Direction that allows field crews to quickly find a given asset. For a given location, such as a street address, this is the relative direction in which to find the asset. For example, a Streetlight may be located at the 'NW' (northwest) corner of the customer's site, or a ServiceDeliveryPoint may be located on the second floor of an apartment building.
  • mainAddress - Main address of the location.
  • phone1 - Phone number.
  • phone2 - Additional phone number.
  • PowerSystemResources - All power system resources at this location.
  • secondaryAddress - Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.
  • ChangeItems
  • RedLines
  • DimensionsInfo
  • LandProperties
  • Assets - All assets at this location.
  • Hazards
  • status - Status of this location.
  • Crews
  • PositionPoints - Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.
  • electronicAddress - Electronic address.
  • Directions
  • Measurements
  • Routes
  • CoordinateSystem - Coordinate system used to describe position points of this location.
  • ErpOrganisations
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'category': <type 'str'>,
 'corporateCode': <type 'str'>,
 'direction': <type 'str'>,
 'geoInfoReference': <type 'str'>}

_attrs

Value:
['category', 'geoInfoReference', 'corporateCode', 'direction']

_defaults

Value:
{'category': '',
 'corporateCode': '',
 'direction': '',
 'geoInfoReference': ''}

_many_refs

Value:
['PowerSystemResources',
 'ChangeItems',
 'RedLines',
 'LandProperties',
 'Assets',
 'Hazards',
 'Crews',
 'PositionPoints',
...

_refs

Value:
['mainAddress',
 'phone1',
 'phone2',
 'PowerSystemResources',
 'secondaryAddress',
 'ChangeItems',
 'RedLines',
 'DimensionsInfo',
...

Property Details [hide private]

Assets

All assets at this location.

Get Method:
getAssets(self) - All assets at this location.
Set Method:
setAssets(self, value)

ChangeItems

Get Method:
getChangeItems(self)
Set Method:
setChangeItems(self, value)

CoordinateSystem

Coordinate system used to describe position points of this location.

Get Method:
getCoordinateSystem(self) - Coordinate system used to describe position points of this location.
Set Method:
setCoordinateSystem(self, value)

Crews

Get Method:
getCrews(self)
Set Method:
setCrews(self, value)

DimensionsInfo

Get Method:
getDimensionsInfo(self)
Set Method:
setDimensionsInfo(self, value)

Directions

Get Method:
getDirections(self)
Set Method:
setDirections(self, value)

ErpOrganisations

Get Method:
getErpOrganisations(self)
Set Method:
setErpOrganisations(self, value)

Hazards

Get Method:
getHazards(self)
Set Method:
setHazards(self, value)

LandProperties

Get Method:
getLandProperties(self)
Set Method:
setLandProperties(self, value)

Measurements

Get Method:
getMeasurements(self)
Set Method:
setMeasurements(self, value)

PositionPoints

Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.

Get Method:
getPositionPoints(self) - Sequence of position points describing this location, expressed in coordinate system 'Location.CoordinateSystem'.
Set Method:
setPositionPoints(self, value)

PowerSystemResources

All power system resources at this location.

Get Method:
getPowerSystemResources(self) - All power system resources at this location.
Set Method:
setPowerSystemResources(self, value)

RedLines

Get Method:
getRedLines(self)
Set Method:
setRedLines(self, value)

Routes

Get Method:
getRoutes(self)
Set Method:
setRoutes(self, value)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Jul 2 18:27:42 2011 http://epydoc.sourceforge.net