Package CIM14 :: Package IEC61968 :: Package PaymentMetering :: Module TariffProfile' :: Class TariffProfile

Class TariffProfile

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

A schedule of charges; structure associated with Tariff that allows the definition of complex tarif structures such as step and time of use when used in conjunction with TimeTariffInterval and Charge. Inherited 'status.value' is defined in the context of the utility's business rules, for example: active, inactive, etc.

Instance Methods

[hide private]

__init__(self, tariffCycle='', ConsumptionTariffIntervals=None, TimeTariffIntervals=None, Tariffs=None, *args, **kw_args)
Initialises a new 'TariffProfile' instance.

addConsumptionTariffIntervals(self, *ConsumptionTariffIntervals)

addTariffs(self, *Tariffs)

addTimeTariffIntervals(self, *TimeTariffIntervals)

getConsumptionTariffIntervals(self)
All consumption tariff intervals used to define this tariff profile.

getTariffs(self)
All tariffs defined by this tariff profile.

getTimeTariffIntervals(self)
All time tariff intervals used to define this tariff profile.

removeConsumptionTariffIntervals(self, *ConsumptionTariffIntervals)

removeTariffs(self, *Tariffs)

removeTimeTariffIntervals(self, *TimeTariffIntervals)

setConsumptionTariffIntervals(self, value)

setTariffs(self, value)

setTimeTariffIntervals(self, value)

Inherited from Common.Document'.Document: addActivityRecords, addMeasurements, getActivityRecords, getMeasurements, removeActivityRecords, removeMeasurements, setActivityRecords, setMeasurements

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 = {'tariffCycle': <type 'str'>}

_attrs = ['tariffCycle']

_defaults = {'tariffCycle': ''}

_many_refs = ['ConsumptionTariffIntervals', 'TimeTariffInterva...

_refs = ['ConsumptionTariffIntervals', 'TimeTariffIntervals', ...

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

Inherited from Element'.Element (private): _enums

Properties

[hide private]

ConsumptionTariffIntervals
All consumption tariff intervals used to define this tariff profile.

Tariffs
All tariffs defined by this tariff profile.

TimeTariffIntervals
All time tariff intervals used to define this tariff profile.

Inherited from Common.Document'.Document: ActivityRecords, Measurements

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

Inherited from object: __class__

Method Details

[hide private]

init(self, tariffCycle=`''`, ConsumptionTariffIntervals=None, TimeTariffIntervals=None, Tariffs=None, *args, **kw_args)
(Constructor)

Initialises a new 'TariffProfile' instance.

Parameters:

tariffCycle - The frequency at which the tariff charge schedule is repeated Examples are: once off on a specified date and time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc. At the end of each cycle, the business rules are reset to start from the beginning again.
ConsumptionTariffIntervals - All consumption tariff intervals used to define this tariff profile.
TimeTariffIntervals - All time tariff intervals used to define this tariff profile.
Tariffs - All tariffs defined by this tariff profile.

Overrides: object.__init__

Class Variable Details

[hide private]

_many_refs

Value:

['ConsumptionTariffIntervals', 'TimeTariffIntervals', 'Tariffs']

_refs

Value:

['ConsumptionTariffIntervals', 'TimeTariffIntervals', 'Tariffs']

Property Details

[hide private]

ConsumptionTariffIntervals

All consumption tariff intervals used to define this tariff profile.

Get Method:: getConsumptionTariffIntervals(self) - All consumption tariff intervals used to define this tariff profile.
Set Method:: setConsumptionTariffIntervals(self, value)

Tariffs

All tariffs defined by this tariff profile.

Get Method:: getTariffs(self) - All tariffs defined by this tariff profile.
Set Method:: setTariffs(self, value)

TimeTariffIntervals

All time tariff intervals used to define this tariff profile.

Get Method:: getTimeTariffIntervals(self) - All time tariff intervals used to define this tariff profile.
Set Method:: setTimeTariffIntervals(self, value)

Class TariffProfile

__init__(self, tariffCycle='', ConsumptionTariffIntervals=None, TimeTariffIntervals=None, Tariffs=None, *args, **kw_args) (Constructor)

_many_refs

_refs

ConsumptionTariffIntervals

Tariffs

TimeTariffIntervals

init(self, tariffCycle=`''`, ConsumptionTariffIntervals=None, TimeTariffIntervals=None, Tariffs=None, *args, **kw_args)
(Constructor)