Class ConsumptionTariffInterval

      object --+    
               |    
Element'.Element --+
                   |
                  ConsumptionTariffInterval

One of a sequence of intervals defined in terms of consumption quantity of a service such as electricity, water, gas, etc. It is typically used in association with TariffProfile to define the steps or blocks in a step tariff structure, where startValue simultaneously defines the entry value of this step and the closing value of the previous step. Where consumption is >= startValue it falls within this interval and where consumption is < startValue it falls within the previous interval.

Instance Methods

[hide private]

__init__(self, sequenceNumber=0, startValue=0.0, TariffProfiles=None, Charges=None, *args, **kw_args)
Initialises a new 'ConsumptionTariffInterval' instance.

addCharges(self, *Charges)

addTariffProfiles(self, *TariffProfiles)

getCharges(self)
All charges used to define this consumption tariff interval.

getTariffProfiles(self)
All tariff profiles defined by this consumption tariff interval.

removeCharges(self, *Charges)

removeTariffProfiles(self, *TariffProfiles)

setCharges(self, value)

setTariffProfiles(self, value)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

_attr_types = {'sequenceNumber': <type 'int'>, 'startValue': <...

_attrs = ['sequenceNumber', 'startValue']

_defaults = {'sequenceNumber': 0, 'startValue': 0.0}

_many_refs = ['TariffProfiles', 'Charges']

_refs = ['TariffProfiles', 'Charges']

Inherited from Element'.Element (private): _enums

Properties

[hide private]

Charges
All charges used to define this consumption tariff interval.

TariffProfiles
All tariff profiles defined by this consumption tariff interval.

Inherited from object: __class__

Method Details

[hide private]

init(self, sequenceNumber=0, startValue=0.0, TariffProfiles=None, Charges=None, *args, **kw_args)
(Constructor)

Initialises a new 'ConsumptionTariffInterval' instance.

Parameters:

sequenceNumber - A sequential reference that defines the identity of this interval and its relative position with respect to other intervals in a sequence of intervals.
startValue - The lowest level of consumption that defines the starting point of this interval. The interval extends to the start of the next interval or until it is reset to the start of the first interval by TariffProfile.tariffCycle.
TariffProfiles - All tariff profiles defined by this consumption tariff interval.
Charges - All charges used to define this consumption tariff interval.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'sequenceNumber': <type 'int'>, 'startValue': <type 'float'>}

Property Details

[hide private]

Charges

All charges used to define this consumption tariff interval.

Get Method:: getCharges(self) - All charges used to define this consumption tariff interval.
Set Method:: setCharges(self, value)

TariffProfiles

All tariff profiles defined by this consumption tariff interval.

Get Method:: getTariffProfiles(self) - All tariff profiles defined by this consumption tariff interval.
Set Method:: setTariffProfiles(self, value)

Class ConsumptionTariffInterval

__init__(self, sequenceNumber=0, startValue=0.0, TariffProfiles=None, Charges=None, *args, **kw_args) (Constructor)

_attr_types

Charges

TariffProfiles

init(self, sequenceNumber=0, startValue=0.0, TariffProfiles=None, Charges=None, *args, **kw_args)
(Constructor)