Package CIM15 :: Package IEC61968 :: Package Customers :: Module PricingStructure' :: Class PricingStructure

Class PricingStructure

                                  object --+            
                                           |            
                            Element'.Element --+        
                                               |        
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+    
                                                   |    
                           Common.Document'.Document --+
                                                       |
                                                      PricingStructure

Grouping of pricing components and prices used in the creation of customer charges and the eligibility criteria under which these terms may be offered to a customer. The reasons for grouping include state, customer classification, site characteristics, classification (i.e. fee price structure, deposit price structure, electric service price structure, etc.) and accounting requirements.Grouping of pricing components and prices used in the creation of customer charges and the eligibility criteria under which these terms may be offered to a customer. The reasons for grouping include state, customer classification, site characteristics, classification (i.e. fee price structure, deposit price structure, electric service price structure, etc.) and accounting requirements.

Instance Methods

[hide private]

__init__(self, dailyFloorUsage=0, dailyCeilingUsage=0, taxExemption=False, code='', dailyEstimatedUsage=0, revenueKind='irrigation', ServiceCategory=None, CustomerAgreements=None, ServiceDeliveryPoints=None, Tariffs=None, Transactions=None, *args, **kw_args)
Initialises a new 'PricingStructure' instance.

addCustomerAgreements(self, *CustomerAgreements)

addServiceDeliveryPoints(self, *ServiceDeliveryPoints)

addTariffs(self, *Tariffs)

addTransactions(self, *Transactions)

getCustomerAgreements(self)
All customer agreements with this pricing structure.

getServiceCategory(self)
Service category to which this pricing structure applies.

getServiceDeliveryPoints(self)
All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.

getTariffs(self)
All tariffs used by this pricing structure.

getTransactions(self)
All transactions applying this pricing structure.

removeCustomerAgreements(self, *CustomerAgreements)

removeServiceDeliveryPoints(self, *ServiceDeliveryPoints)

removeTariffs(self, *Tariffs)

removeTransactions(self, *Transactions)

setCustomerAgreements(self, value)

setServiceCategory(self, value)

setServiceDeliveryPoints(self, value)

setTariffs(self, value)

setTransactions(self, value)

Inherited from Common.Document'.Document: addActivityRecords, addAssetRoles, addChangeItems, addChangeSets, addErpOrganisationRoles, addErpPersonRoles, addFromDocumentRoles, addMeasurements, addNetworkDataSets, addPowerSystemResourceRoles, addScheduleParameterInfos, addScheduledEvents, addToDocumentRoles, getActivityRecords, getAssetRoles, getChangeItems, getChangeSets, getErpOrganisationRoles, getErpPersonRoles, getFromDocumentRoles, getMeasurements, getNetworkDataSets, getPowerSystemResourceRoles, getScheduleParameterInfos, getScheduledEvents, getToDocumentRoles, removeActivityRecords, removeAssetRoles, removeChangeItems, removeChangeSets, removeErpOrganisationRoles, removeErpPersonRoles, removeFromDocumentRoles, removeMeasurements, removeNetworkDataSets, removePowerSystemResourceRoles, removeScheduleParameterInfos, removeScheduledEvents, removeToDocumentRoles, setActivityRecords, setAssetRoles, setChangeItems, setChangeSets, setErpOrganisationRoles, setErpPersonRoles, setFromDocumentRoles, setMeasurements, setNetworkDataSets, setPowerSystemResourceRoles, setScheduleParameterInfos, setScheduledEvents, setToDocumentRoles

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 = {'code': <type 'str'>, 'dailyCeilingUsage': <typ...

_attrs = ['dailyFloorUsage', 'dailyCeilingUsage', 'taxExemptio...

_defaults = {'code': '', 'dailyCeilingUsage': 0, 'dailyEstimat...

_enums = {'revenueKind': 'RevenueKind'}

_many_refs = ['CustomerAgreements', 'ServiceDeliveryPoints', '...

_refs = ['ServiceCategory', 'CustomerAgreements', 'ServiceDeli...

Inherited from Common.Document'.Document: docStatus, electronicAddress, status

Properties

[hide private]

CustomerAgreements
All customer agreements with this pricing structure.

ServiceCategory
Service category to which this pricing structure applies.

ServiceDeliveryPoints
All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.

Tariffs
All tariffs used by this pricing structure.

Transactions
All transactions applying this pricing structure.

Inherited from Common.Document'.Document: ActivityRecords, AssetRoles, ChangeItems, ChangeSets, ErpOrganisationRoles, ErpPersonRoles, FromDocumentRoles, Measurements, NetworkDataSets, PowerSystemResourceRoles, ScheduleParameterInfos, ScheduledEvents, ToDocumentRoles

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

Inherited from object: __class__

Method Details

[hide private]

init(self, dailyFloorUsage=0, dailyCeilingUsage=0, taxExemption=False, code=`''`, dailyEstimatedUsage=0, revenueKind=`'irrigation'`, ServiceCategory=None, CustomerAgreements=None, ServiceDeliveryPoints=None, Tariffs=None, Transactions=None, *args, **kw_args)
(Constructor)

Initialises a new 'PricingStructure' instance.

Parameters:

dailyFloorUsage - Absolute minimum valid non-demand usage quantity used in validating a customer's billed non-demand usage.
dailyCeilingUsage - Absolute maximum valid non-demand usage quantity used in validating a customer's billed non-demand usage.
taxExemption - True if this pricing structure is not taxable.
code - Unique user-allocated key for this pricing structure, used by company representatives to identify the correct price structure for allocating to a customer. For rate schedules it is often prefixed by a state code.
dailyEstimatedUsage - Used in place of actual computed estimated average when history of usage is not available, and typically manually entered by customer accounting.
revenueKind - (Accounting) Kind of revenue, often used to determine the grace period allowed, before collection actions are taken on a customer (grace periods vary between revenue classes). Values are: "irrigation", "residential", "nonResidential", "industrial", "other", "commercial", "streetLight"
ServiceCategory - Service category to which this pricing structure applies.
CustomerAgreements - All customer agreements with this pricing structure.
ServiceDeliveryPoints - All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.
Tariffs - All tariffs used by this pricing structure.
Transactions - All transactions applying this pricing structure.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'code': <type 'str'>,
 'dailyCeilingUsage': <type 'int'>,
 'dailyEstimatedUsage': <type 'int'>,
 'dailyFloorUsage': <type 'int'>,
 'revenueKind': <type 'str'>,
 'taxExemption': <type 'bool'>}

_attrs

Value:

['dailyFloorUsage',
 'dailyCeilingUsage',
 'taxExemption',
 'code',
 'dailyEstimatedUsage',
 'revenueKind']

_defaults

Value:

{'code': '',
 'dailyCeilingUsage': 0,
 'dailyEstimatedUsage': 0,
 'dailyFloorUsage': 0,
 'revenueKind': 'irrigation',
 'taxExemption': False}

_many_refs

Value:

['CustomerAgreements',
 'ServiceDeliveryPoints',
 'Tariffs',
 'Transactions']

_refs

Value:

['ServiceCategory',
 'CustomerAgreements',
 'ServiceDeliveryPoints',
 'Tariffs',
 'Transactions']

Property Details

[hide private]

CustomerAgreements

All customer agreements with this pricing structure.

Get Method:: getCustomerAgreements(self) - All customer agreements with this pricing structure.
Set Method:: setCustomerAgreements(self, value)

ServiceCategory

Service category to which this pricing structure applies.

Get Method:: getServiceCategory(self) - Service category to which this pricing structure applies.
Set Method:: setServiceCategory(self, value)

ServiceDeliveryPoints

All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.

Get Method:: getServiceDeliveryPoints(self) - All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.
Set Method:: setServiceDeliveryPoints(self, value)

Tariffs

All tariffs used by this pricing structure.

Get Method:: getTariffs(self) - All tariffs used by this pricing structure.
Set Method:: setTariffs(self, value)

Transactions

All transactions applying this pricing structure.

Get Method:: getTransactions(self) - All transactions applying this pricing structure.
Set Method:: setTransactions(self, value)

Class PricingStructure

__init__(self, dailyFloorUsage=0, dailyCeilingUsage=0, taxExemption=False, code='', dailyEstimatedUsage=0, revenueKind='irrigation', ServiceCategory=None, CustomerAgreements=None, ServiceDeliveryPoints=None, Tariffs=None, Transactions=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_many_refs

_refs

CustomerAgreements

ServiceCategory

ServiceDeliveryPoints

Tariffs

Transactions

init(self, dailyFloorUsage=0, dailyCeilingUsage=0, taxExemption=False, code=`''`, dailyEstimatedUsage=0, revenueKind=`'irrigation'`, ServiceCategory=None, CustomerAgreements=None, ServiceDeliveryPoints=None, Tariffs=None, Transactions=None, *args, **kw_args)
(Constructor)