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

Class Charge

                                  object --+        
                                           |        
                            Element'.Element --+    
                                               |    
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+
                                                   |
                                                  Charge

A charge element associated with other entities such as tariff structures, auxiliary agreements or other charge elements. The total charge amount applicable to this instance of Charge is the sum of fixedPortion plus percentagePortion.

Instance Methods

[hide private]

__init__(self, kind='demandCharge', variablePortion=0.0, AuxiliaryAccounts=None, ParentCharge=None, ChildCharges=None, fixedPortion=None, ConsumptionTariffIntervals=None, TimeTariffIntervals=None, *args, **kw_args)
Initialises a new 'Charge' instance.

addAuxiliaryAccounts(self, *AuxiliaryAccounts)

addChildCharges(self, *ChildCharges)

addConsumptionTariffIntervals(self, *ConsumptionTariffIntervals)

addTimeTariffIntervals(self, *TimeTariffIntervals)

getAuxiliaryAccounts(self)
All auxiliary accounts to which this charge must be levied.

getChildCharges(self)
All sub-components of this complex charge.

getConsumptionTariffIntervals(self)
Tariff intervals to which this consumption-based charge must be levied.

getParentCharge(self)

getTimeTariffIntervals(self)
Tariff intervals to which this time-based charge must be levied.

removeAuxiliaryAccounts(self, *AuxiliaryAccounts)

removeChildCharges(self, *ChildCharges)

removeConsumptionTariffIntervals(self, *ConsumptionTariffIntervals)

removeTimeTariffIntervals(self, *TimeTariffIntervals)

setAuxiliaryAccounts(self, value)

setChildCharges(self, value)

setConsumptionTariffIntervals(self, value)

setParentCharge(self, value)

setTimeTariffIntervals(self, value)

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 = {'kind': <type 'str'>, 'variablePortion': <type ...

_attrs = ['kind', 'variablePortion']

_defaults = {'kind': 'demandCharge', 'variablePortion': 0.0}

_enums = {'kind': 'ChargeKind'}

_many_refs = ['AuxiliaryAccounts', 'ChildCharges', 'Consumptio...

_refs = ['AuxiliaryAccounts', 'ParentCharge', 'ChildCharges', ...

fixedPortion = None

Properties

[hide private]

AuxiliaryAccounts
All auxiliary accounts to which this charge must be levied.

ChildCharges
All sub-components of this complex charge.

ConsumptionTariffIntervals
Tariff intervals to which this consumption-based charge must be levied.

ParentCharge

TimeTariffIntervals
Tariff intervals to which this time-based charge must be levied.

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

Inherited from object: __class__

Method Details

[hide private]

init(self, kind=`'demandCharge'`, variablePortion=0.0, AuxiliaryAccounts=None, ParentCharge=None, ChildCharges=None, fixedPortion=None, ConsumptionTariffIntervals=None, TimeTariffIntervals=None, *args, **kw_args)
(Constructor)

Initialises a new 'Charge' instance.

Parameters:

kind - The kind of charge to be applied. Values are: "demandCharge", "other", "auxiliaryCharge", "taxCharge", "consumptionCharge"
variablePortion - The variable portion of this charge element, calculated as a percentage of the total amount of a parent charge.
AuxiliaryAccounts - All auxiliary accounts to which this charge must be levied.
ParentCharge
ChildCharges - All sub-components of this complex charge.
fixedPortion - The fixed portion of this charge element.
ConsumptionTariffIntervals - Tariff intervals to which this consumption-based charge must be levied.
TimeTariffIntervals - Tariff intervals to which this time-based charge must be levied.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'kind': <type 'str'>, 'variablePortion': <type 'float'>}

_many_refs

Value:

['AuxiliaryAccounts',
 'ChildCharges',
 'ConsumptionTariffIntervals',
 'TimeTariffIntervals']

_refs

Value:

['AuxiliaryAccounts',
 'ParentCharge',
 'ChildCharges',
 'fixedPortion',
 'ConsumptionTariffIntervals',
 'TimeTariffIntervals']

Property Details

[hide private]

AuxiliaryAccounts

All auxiliary accounts to which this charge must be levied.

Get Method:: getAuxiliaryAccounts(self) - All auxiliary accounts to which this charge must be levied.
Set Method:: setAuxiliaryAccounts(self, value)

ChildCharges

All sub-components of this complex charge.

Get Method:: getChildCharges(self) - All sub-components of this complex charge.
Set Method:: setChildCharges(self, value)

ConsumptionTariffIntervals

Tariff intervals to which this consumption-based charge must be levied.

Get Method:: getConsumptionTariffIntervals(self) - Tariff intervals to which this consumption-based charge must be levied.
Set Method:: setConsumptionTariffIntervals(self, value)

ParentCharge

Get Method:: getParentCharge(self)
Set Method:: setParentCharge(self, value)

TimeTariffIntervals

Tariff intervals to which this time-based charge must be levied.

Get Method:: getTimeTariffIntervals(self) - Tariff intervals to which this time-based charge must be levied.
Set Method:: setTimeTariffIntervals(self, value)

Class Charge

__init__(self, kind='demandCharge', variablePortion=0.0, AuxiliaryAccounts=None, ParentCharge=None, ChildCharges=None, fixedPortion=None, ConsumptionTariffIntervals=None, TimeTariffIntervals=None, *args, **kw_args) (Constructor)

_attr_types

_many_refs

_refs

AuxiliaryAccounts

ChildCharges

ConsumptionTariffIntervals

ParentCharge

TimeTariffIntervals

init(self, kind=`'demandCharge'`, variablePortion=0.0, AuxiliaryAccounts=None, ParentCharge=None, ChildCharges=None, fixedPortion=None, ConsumptionTariffIntervals=None, TimeTariffIntervals=None, *args, **kw_args)
(Constructor)