Package CIM15 :: Package IEC61968 :: Package Metering :: Module EndDevice' :: Class EndDevice

Class EndDevice

                                  object --+                
                                           |                
                            Element'.Element --+            
                                               |            
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+        
                                                   |        
                                 Assets.Asset'.Asset --+    
                                                       |    
                   Assets.AssetContainer'.AssetContainer --+
                                                           |
                                                          EndDevice

Known Subclasses:

Meter'.Meter

Asset container that performs one or more end device functions. One type of end device is a meter which can perform metering, load management, connect/disconnect, accounting functions, etc. Some end devices, such as ones monitoring and controlling air conditioner, refrigerator, pool pumps may be connected to a meter. All end devices may have communication capability defined by the associated communication function(s). An end device 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.Asset container that performs one or more end device functions. One type of end device is a meter which can perform metering, load management, connect/disconnect, accounting functions, etc. Some end devices, such as ones monitoring and controlling air conditioner, refrigerator, pool pumps may be connected to a meter. All end devices may have communication capability defined by the associated communication function(s). An end device 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, timeZoneOffset=0.0, amrSystem='', EndDeviceInfo=None, ServiceDeliveryPoint=None, ServiceLocation=None, EndDeviceFunctions=None, EndDeviceControls=None, Customer=None, EndDeviceGroups=None, *args, **kw_args)
Initialises a new 'EndDevice' instance.

addEndDeviceControls(self, *EndDeviceControls)

addEndDeviceFunctions(self, *EndDeviceFunctions)

addEndDeviceGroups(self, *EndDeviceGroups)

getCustomer(self)
Customer owning this end device.

getEndDeviceControls(self)
All end device controls sending commands to this end device.

getEndDeviceFunctions(self)
All end device functions this end device performs.

getEndDeviceGroups(self)
All end device groups referring to this end device.

getEndDeviceInfo(self)
End device data.

getServiceDeliveryPoint(self)
Service delivery point to which this end device belongs.

getServiceLocation(self)
Service location whose service delivery is measured by this end device.

removeEndDeviceControls(self, *EndDeviceControls)

removeEndDeviceFunctions(self, *EndDeviceFunctions)

removeEndDeviceGroups(self, *EndDeviceGroups)

setCustomer(self, value)

setEndDeviceControls(self, value)

setEndDeviceFunctions(self, value)

setEndDeviceGroups(self, value)

setEndDeviceInfo(self, value)

setServiceDeliveryPoint(self, value)

setServiceLocation(self, value)

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

Inherited from Assets.Asset'.Asset: addActivityRecords, addAssetFunctions, addAssetPropertyCurves, addChangeItems, addDocumentRoles, addErpOrganisationRoles, addErpRecDeliveryItems, addFromAssetRoles, addMeasurements, addMediums, addPowerSystemResources, addProperties, addRatings, addReliabilityInfos, addScheduledEvents, addToAssetRoles, getActivityRecords, getAssetContainer, getAssetFunctions, getAssetInfo, getAssetPropertyCurves, getChangeItems, getDocumentRoles, getErpInventory, getErpItemMaster, getErpOrganisationRoles, getErpRecDeliveryItems, getFinancialInfo, getFromAssetRoles, getLocation, getMeasurements, getMediums, getPowerSystemResources, getProperties, getRatings, getReliabilityInfos, getScheduledEvents, getToAssetRoles, getWorkTask, removeActivityRecords, removeAssetFunctions, removeAssetPropertyCurves, removeChangeItems, removeDocumentRoles, removeErpOrganisationRoles, removeErpRecDeliveryItems, removeFromAssetRoles, removeMeasurements, removeMediums, removePowerSystemResources, removeProperties, removeRatings, removeReliabilityInfos, removeScheduledEvents, removeToAssetRoles, setActivityRecords, setAssetContainer, setAssetFunctions, setAssetInfo, setAssetPropertyCurves, setChangeItems, setDocumentRoles, setErpInventory, setErpItemMaster, setErpOrganisationRoles, setErpRecDeliveryItems, setFinancialInfo, setFromAssetRoles, setLocation, setMeasurements, setMediums, setPowerSystemResources, setProperties, setRatings, setReliabilityInfos, setScheduledEvents, setToAssetRoles, setWorkTask

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 = {'amrSystem': <type 'str'>, 'timeZoneOffset': <t...

_attrs = ['timeZoneOffset', 'amrSystem']

_defaults = {'amrSystem': '', 'timeZoneOffset': 0.0}

_many_refs = ['EndDeviceFunctions', 'EndDeviceControls', 'EndD...

_refs = ['EndDeviceInfo', 'ServiceDeliveryPoint', 'ServiceLoca...

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

Inherited from Element'.Element (private): _enums

Properties

[hide private]

Customer
Customer owning this end device.

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

EndDeviceFunctions
All end device functions this end device performs.

EndDeviceGroups
All end device groups referring to this end device.

EndDeviceInfo
End device data.

ServiceDeliveryPoint
Service delivery point to which this end device belongs.

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

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

Inherited from Assets.Asset'.Asset: ActivityRecords, AssetContainer, AssetFunctions, AssetInfo, AssetPropertyCurves, ChangeItems, DocumentRoles, ErpInventory, ErpItemMaster, ErpOrganisationRoles, ErpRecDeliveryItems, FinancialInfo, FromAssetRoles, Location, Measurements, Mediums, PowerSystemResources, Properties, Ratings, ReliabilityInfos, ScheduledEvents, ToAssetRoles, WorkTask

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

Inherited from object: __class__

Method Details

[hide private]

init(self, timeZoneOffset=0.0, amrSystem=`''`, EndDeviceInfo=None, ServiceDeliveryPoint=None, ServiceLocation=None, EndDeviceFunctions=None, EndDeviceControls=None, Customer=None, EndDeviceGroups=None, *args, **kw_args)
(Constructor)

Initialises a new 'EndDevice' instance.

Parameters:

timeZoneOffset - Time zone offset relative to GMT for the location of this end device.
amrSystem - Automated meter reading (AMR) system responsible for communications to this end device.
EndDeviceInfo - End device data.
ServiceDeliveryPoint - Service delivery point to which this end device belongs.
ServiceLocation - Service location whose service delivery is measured by this end device.
EndDeviceFunctions - All end device functions this end device performs.
EndDeviceControls - All end device controls sending commands to this end device.
Customer - Customer owning this end device.
EndDeviceGroups - All end device groups referring to this end device.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'amrSystem': <type 'str'>, 'timeZoneOffset': <type 'float'>}

_many_refs

Value:

['EndDeviceFunctions', 'EndDeviceControls', 'EndDeviceGroups']

_refs

Value:

['EndDeviceInfo',
 'ServiceDeliveryPoint',
 'ServiceLocation',
 'EndDeviceFunctions',
 'EndDeviceControls',
 'Customer',
 'EndDeviceGroups']

Property Details

[hide private]

Customer

Customer owning this end device.

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

EndDeviceControls

All end device controls sending commands to this end device.

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

EndDeviceFunctions

All end device functions this end device performs.

Get Method:: getEndDeviceFunctions(self) - All end device functions this end device performs.
Set Method:: setEndDeviceFunctions(self, value)

EndDeviceGroups

All end device groups referring to this end device.

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

EndDeviceInfo

End device data.

Get Method:: getEndDeviceInfo(self) - End device data.
Set Method:: setEndDeviceInfo(self, value)

ServiceDeliveryPoint

Service delivery point to which this end device belongs.

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

ServiceLocation

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

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

Class EndDevice

__init__(self, timeZoneOffset=0.0, amrSystem='', EndDeviceInfo=None, ServiceDeliveryPoint=None, ServiceLocation=None, EndDeviceFunctions=None, EndDeviceControls=None, Customer=None, EndDeviceGroups=None, *args, **kw_args) (Constructor)

_attr_types

_many_refs

_refs

Customer

EndDeviceControls

EndDeviceFunctions

EndDeviceGroups

EndDeviceInfo

ServiceDeliveryPoint

ServiceLocation

init(self, timeZoneOffset=0.0, amrSystem=`''`, EndDeviceInfo=None, ServiceDeliveryPoint=None, ServiceLocation=None, EndDeviceFunctions=None, EndDeviceControls=None, Customer=None, EndDeviceGroups=None, *args, **kw_args)
(Constructor)