Trees       Indices       Help   
PyCIM
Package CIM14 :: Package IEC61968 :: Package Metering :: Module EndDeviceAsset' :: Class EndDeviceAsset
[hide private]
[frames] | no frames]

Class EndDeviceAsset

                                  object --+                
                                           |                
                            Element'.Element --+            
                                               |            
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+        
                                                   |        
                                 Assets.Asset'.Asset --+    
                                                       |    
                   Assets.AssetContainer'.AssetContainer --+
                                                           |
                                                          EndDeviceAsset
Known Subclasses:

AssetContainer that performs one or more end device functions. One type of EndDeviceAsset is a MeterAsset which can perform metering, load management, connect/disconnect, accounting functions, etc. Some EndDeviceAssets, such as ones monitoring and controlling air conditioner, refrigerator, pool pumps may be connected to a MeterAsset. All EndDeviceAssets may have communication capability defined by the associated ComFunction(s). An EndDeviceAsset may be owned by a consumer, a service provider, utility or otherwise. There may be a related end device function that identifies a sensor or control point within a metering application or communications systems (e.g., water, gas, electricity). Some devices may use an optical port that conforms to the ANSI C12.18 standard for communications.

Instance Methods [hide private]
 
__init__(self, readRequest=False, demandResponse=False, relayCapable=False, amrSystem='', ratedCurrent=0.0, phaseCount=0, reverseFlowHandling=False, metrology=False, timeZoneOffset=0.0, outageReport=False, dstEnabled=False, disconnect=False, ratedVoltage=0.0, loadControl=False, EndDeviceGroups=None, ServiceLocation=None, EndDeviceModel=None, DeviceFunctions=None, ServiceDeliveryPoint=None, Readings=None, EndDeviceControls=None, Customer=None, *args, **kw_args)
Initialises a new 'EndDeviceAsset' instance.
 
addDeviceFunctions(self, *DeviceFunctions)
 
addEndDeviceControls(self, *EndDeviceControls)
 
addEndDeviceGroups(self, *EndDeviceGroups)
 
addReadings(self, *Readings)
 
getCustomer(self)
Customer owning this end device asset.
 
getDeviceFunctions(self)
All device functions this end device asset performs.
 
getEndDeviceControls(self)
All end device controls sending commands to this end device asset.
 
getEndDeviceGroups(self)
All end device groups referring to this end device asset.
 
getEndDeviceModel(self)
Product documentation for this end device asset.
 
getReadings(self)
 
getServiceDeliveryPoint(self)
Service delivery point to which this end device asset belongs.
 
getServiceLocation(self)
Service location whose service delivery is measured by this end device asset.
 
removeDeviceFunctions(self, *DeviceFunctions)
 
removeEndDeviceControls(self, *EndDeviceControls)
 
removeEndDeviceGroups(self, *EndDeviceGroups)
 
removeReadings(self, *Readings)
 
setCustomer(self, value)
 
setDeviceFunctions(self, value)
 
setEndDeviceControls(self, value)
 
setEndDeviceGroups(self, value)
 
setEndDeviceModel(self, value)
 
setReadings(self, value)
 
setServiceDeliveryPoint(self, value)
 
setServiceLocation(self, value)

Inherited from Assets.AssetContainer'.AssetContainer: addAssets, addSeals, getAssets, getSeals, removeAssets, removeSeals, setAssets, setSeals

Inherited from Assets.Asset'.Asset: addActivityRecords, addAssetFunctions, addMeasurements, addPowerSystemResources, addProperties, addRatings, getActivityRecords, getAssetContainer, getAssetFunctions, getLocation, getMeasurements, getPowerSystemResources, getProperties, getRatings, removeActivityRecords, removeAssetFunctions, removeMeasurements, removePowerSystemResources, removeProperties, removeRatings, setActivityRecords, setAssetContainer, setAssetFunctions, setLocation, setMeasurements, setPowerSystemResources, setProperties, setRatings

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 = {'amrSystem': <type 'str'>, 'demandResponse': <t...
  _attrs = ['readRequest', 'demandResponse', 'relayCapable', 'am...
  _defaults = {'amrSystem': '', 'demandResponse': False, 'discon...
  _many_refs = ['EndDeviceGroups', 'DeviceFunctions', 'Readings'...
  _refs = ['EndDeviceGroups', 'ServiceLocation', 'EndDeviceModel...

Inherited from Assets.Asset'.Asset: acceptanceTest, electronicAddress, status

Inherited from Element'.Element (private): _enums

Properties [hide private]
  Customer
Customer owning this end device asset.
  DeviceFunctions
All device functions this end device asset performs.
  EndDeviceControls
All end device controls sending commands to this end device asset.
  EndDeviceGroups
All end device groups referring to this end device asset.
  EndDeviceModel
Product documentation for this end device asset.
  Readings
  ServiceDeliveryPoint
Service delivery point to which this end device asset belongs.
  ServiceLocation
Service location whose service delivery is measured by this end device asset.

Inherited from Assets.AssetContainer'.AssetContainer: Assets, Seals

Inherited from Assets.Asset'.Asset: ActivityRecords, AssetContainer, AssetFunctions, Location, Measurements, PowerSystemResources, Properties, Ratings

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, readRequest=False, demandResponse=False, relayCapable=False, amrSystem='', ratedCurrent=0.0, phaseCount=0, reverseFlowHandling=False, metrology=False, timeZoneOffset=0.0, outageReport=False, dstEnabled=False, disconnect=False, ratedVoltage=0.0, loadControl=False, EndDeviceGroups=None, ServiceLocation=None, EndDeviceModel=None, DeviceFunctions=None, ServiceDeliveryPoint=None, Readings=None, EndDeviceControls=None, Customer=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'EndDeviceAsset' instance.

Parameters:
  • readRequest - True if this end device asset is capable of supporting on-request reads for this end device.
  • demandResponse - True if this end device asset is capable of supporting demand response functions. To determine whether this functionality is installed and enabled, check the 'DeviceFunction.disabled' attribute of the respective function contained by this end device asset.
  • relayCapable - True if this end device asset is capable of supporting one or more relays. The relays may be programmable in the meter and tied to TOU, time pulse, load control or other functions. To determine whether this functionality is installed and enabled, check the 'DeviceFunction.disabled' attribute of the respective function contained by this end device asset.
  • amrSystem - Automated meter reading (AMR) system responsible for communications to this end device.
  • ratedCurrent - Rated current.
  • phaseCount - Number of potential phases the asset supports, typically 0, 1 or 3.
  • reverseFlowHandling - True if this EndDeviceAsset is capable of supporting detection and monitoring of reverse flow.
  • metrology - True if this end device asset is capable of supporting the presentation of metered values to a user or another system (always true for a meter, but might not be true for a load control unit.)
  • timeZoneOffset - Time zone offset relative to GMT for the location of this end device.
  • outageReport - True if this end device asset is capable of supporting the means to report historical power interruption data.
  • dstEnabled - True if this end device asset is capable of supporting the autonomous application of daylight savings time (DST).
  • disconnect - True if this end device asset is capable of supporting remote whole-house disconnect capability. To determine whether this functionality is installed and enabled, check the 'DeviceFunction.disabled' attribute of the ConnectDisconnectFunction contained by this end device asset. For example, to be able to remotely disconnect the device, the following values of attributes must hold: - EndDeviceAsset.disconnect = true (device supports disconnect) - ConnectDisconnectFunction.disabled (inherited from DeviceFunction) = false (function enabled) - ConnectDisconnectFunction.isConnected = true (currently connected).
  • ratedVoltage - Rated voltage.
  • loadControl - True if this end device asset is capable of supporting load control functions through either the meter or the AMR option. To determine whether this functionality is installed and enabled, check the 'DeviceFunction.disabled' attribute of the respective function contained by this end device asset.
  • EndDeviceGroups - All end device groups referring to this end device asset.
  • ServiceLocation - Service location whose service delivery is measured by this end device asset.
  • EndDeviceModel - Product documentation for this end device asset.
  • DeviceFunctions - All device functions this end device asset performs.
  • ServiceDeliveryPoint - Service delivery point to which this end device asset belongs.
  • Readings
  • EndDeviceControls - All end device controls sending commands to this end device asset.
  • Customer - Customer owning this end device asset.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'amrSystem': <type 'str'>,
 'demandResponse': <type 'bool'>,
 'disconnect': <type 'bool'>,
 'dstEnabled': <type 'bool'>,
 'loadControl': <type 'bool'>,
 'metrology': <type 'bool'>,
 'outageReport': <type 'bool'>,
 'phaseCount': <type 'int'>,
...

_attrs

Value:
['readRequest',
 'demandResponse',
 'relayCapable',
 'amrSystem',
 'ratedCurrent',
 'phaseCount',
 'reverseFlowHandling',
 'metrology',
...

_defaults

Value:
{'amrSystem': '',
 'demandResponse': False,
 'disconnect': False,
 'dstEnabled': False,
 'loadControl': False,
 'metrology': False,
 'outageReport': False,
 'phaseCount': 0,
...

_many_refs

Value:
['EndDeviceGroups',
 'DeviceFunctions',
 'Readings',
 'EndDeviceControls']

_refs

Value:
['EndDeviceGroups',
 'ServiceLocation',
 'EndDeviceModel',
 'DeviceFunctions',
 'ServiceDeliveryPoint',
 'Readings',
 'EndDeviceControls',
 'Customer']

Property Details [hide private]

Customer

Customer owning this end device asset.

Get Method:
getCustomer(self) - Customer owning this end device asset.
Set Method:
setCustomer(self, value)

DeviceFunctions

All device functions this end device asset performs.

Get Method:
getDeviceFunctions(self) - All device functions this end device asset performs.
Set Method:
setDeviceFunctions(self, value)

EndDeviceControls

All end device controls sending commands to this end device asset.

Get Method:
getEndDeviceControls(self) - All end device controls sending commands to this end device asset.
Set Method:
setEndDeviceControls(self, value)

EndDeviceGroups

All end device groups referring to this end device asset.

Get Method:
getEndDeviceGroups(self) - All end device groups referring to this end device asset.
Set Method:
setEndDeviceGroups(self, value)

EndDeviceModel

Product documentation for this end device asset.

Get Method:
getEndDeviceModel(self) - Product documentation for this end device asset.
Set Method:
setEndDeviceModel(self, value)

Readings

Get Method:
getReadings(self)
Set Method:
setReadings(self, value)

ServiceDeliveryPoint

Service delivery point to which this end device asset belongs.

Get Method:
getServiceDeliveryPoint(self) - Service delivery point to which this end device asset belongs.
Set Method:
setServiceDeliveryPoint(self, value)

ServiceLocation

Service location whose service delivery is measured by this end device asset.

Get Method:
getServiceLocation(self) - Service location whose service delivery is measured by this end device asset.
Set Method:
setServiceLocation(self, value)

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