Trees       Indices       Help   
PyCIM
Package CIM14 :: 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 is defined with one or more postition points (coordinates) in a given coordinate system.

Instance Methods [hide private]
 
__init__(self, geoInfoReference='', corporateCode='', direction='', category='', PositionPoints=None, PowerSystemResources=None, CoordinateSystems=None, Measurements=None, secondaryAddress=None, Assets=None, phone2=None, electronicAddress=None, phone1=None, mainAddress=None, status=None, *args, **kw_args)
Initialises a new 'Location' instance.
 
addAssets(self, *Assets)
 
addCoordinateSystems(self, *CoordinateSystems)
 
addMeasurements(self, *Measurements)
 
addPositionPoints(self, *PositionPoints)
 
addPowerSystemResources(self, *PowerSystemResources)
 
getAssets(self)
All assets at this location.
 
getCoordinateSystems(self)
All coordinate systems used to describe position points of this location.
 
getMeasurements(self)
 
getPositionPoints(self)
Sequence of position points describing this location.
 
getPowerSystemResources(self)
All power system resources at this location.
 
removeAssets(self, *Assets)
 
removeCoordinateSystems(self, *CoordinateSystems)
 
removeMeasurements(self, *Measurements)
 
removePositionPoints(self, *PositionPoints)
 
removePowerSystemResources(self, *PowerSystemResources)
 
setAssets(self, value)
 
setCoordinateSystems(self, value)
 
setMeasurements(self, value)
 
setPositionPoints(self, value)
 
setPowerSystemResources(self, value)

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

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 = ['geoInfoReference', 'corporateCode', 'direction', 'c...
  _defaults = {'category': '', 'corporateCode': '', 'direction':...
  _many_refs = ['PositionPoints', 'PowerSystemResources', 'Coord...
  _refs = ['PositionPoints', 'PowerSystemResources', 'Coordinate...
  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.
  CoordinateSystems
All coordinate systems used to describe position points of this location.
  Measurements
  PositionPoints
Sequence of position points describing this location.
  PowerSystemResources
All power system resources at this location.

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details [hide private]

__init__(self, geoInfoReference='', corporateCode='', direction='', category='', PositionPoints=None, PowerSystemResources=None, CoordinateSystems=None, Measurements=None, secondaryAddress=None, Assets=None, phone2=None, electronicAddress=None, phone1=None, mainAddress=None, status=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Location' instance.

Parameters:
  • 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.
  • 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).
  • PositionPoints - Sequence of position points describing this location.
  • PowerSystemResources - All power system resources at this location.
  • CoordinateSystems - All coordinate systems used to describe position points of this location.
  • Measurements
  • secondaryAddress - Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.
  • Assets - All assets at this location.
  • phone2 - Additional phone number.
  • electronicAddress - Electronic address.
  • phone1 - Phone number.
  • mainAddress - Main address of the location.
  • status - Status of this location.
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:
['geoInfoReference', 'corporateCode', 'direction', 'category']

_defaults

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

_many_refs

Value:
['PositionPoints',
 'PowerSystemResources',
 'CoordinateSystems',
 'Measurements',
 'Assets']

_refs

Value:
['PositionPoints',
 'PowerSystemResources',
 'CoordinateSystems',
 'Measurements',
 'secondaryAddress',
 'Assets',
 'phone2',
 'electronicAddress',
...

Property Details [hide private]

Assets

All assets at this location.

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

CoordinateSystems

All coordinate systems used to describe position points of this location.

Get Method:
getCoordinateSystems(self) - All coordinate systems used to describe position points of this location.
Set Method:
setCoordinateSystems(self, value)

Measurements

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

PositionPoints

Sequence of position points describing this location.

Get Method:
getPositionPoints(self) - Sequence of position points describing this location.
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)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Nov 13 22:18:03 2010 http://epydoc.sourceforge.net