Package CIM14 :: Package IEC61968 :: Package PaymentMetering :: Module TimeTariffInterval' :: Class TimeTariffInterval
[hide private]
[frames] | no frames]

Class TimeTariffInterval

      object --+    
               |    
Element'.Element --+
                   |
                  TimeTariffInterval

One of a sequence of time intervals defined in terms of real time. It is typically used in association with TariffProfile to define the intervals in a time of use tariff structure, where startDateTime simultaneously determines the starting point of this interval and the ending point of the previous interval.

Instance Methods [hide private]
 
__init__(self, sequenceNumber=0, startDateTime='', TariffProfiles=None, Charges=None, *args, **kw_args)
Initialises a new 'TimeTariffInterval' instance.
 
addCharges(self, *Charges)
 
addTariffProfiles(self, *TariffProfiles)
 
getCharges(self)
All charges used to define this time tariff interval.
 
getTariffProfiles(self)
All tariff profiles defined by this time 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'>, 'startDateTime'...
  _attrs = ['sequenceNumber', 'startDateTime']
  _defaults = {'sequenceNumber': 0, 'startDateTime': ''}
  _many_refs = ['TariffProfiles', 'Charges']
  _refs = ['TariffProfiles', 'Charges']

Inherited from Element'.Element (private): _enums

Properties [hide private]
  Charges
All charges used to define this time tariff interval.
  TariffProfiles
All tariff profiles defined by this time tariff interval.

Inherited from object: __class__

Method Details [hide private]

__init__(self, sequenceNumber=0, startDateTime='', TariffProfiles=None, Charges=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'TimeTariffInterval' 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.
  • startDateTime - A real time marker that defines the starting time (typically it is the time of day) for 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 time tariff interval.
  • Charges - All charges used to define this time tariff interval.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'sequenceNumber': <type 'int'>, 'startDateTime': <type 'str'>}

Property Details [hide private]

Charges

All charges used to define this time tariff interval.

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

TariffProfiles

All tariff profiles defined by this time tariff interval.

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