Package CIM15 :: 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 fixed and variable portion.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 fixed and variable portion.

Instance Methods

[hide private]

__init__(self, variablePortion=0.0, kind='other', ConsumptionTariffIntervals=None, TimeTariffIntervals=None, AuxiliaryAccounts=None, ChildCharges=None, fixedPortion=None, ParentCharge=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)
Parent of this charge sub-component.

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

_attrs = ['variablePortion', 'kind']

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

_enums = {'kind': 'ChargeKind'}

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

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

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
Parent of this charge sub-component.

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

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

Inherited from object: __class__

Method Details

[hide private]

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

Initialises a new 'Charge' instance.

Parameters:

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

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

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

_many_refs

Value:

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

_refs

Value:

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

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

Parent of this charge sub-component.

Get Method:: getParentCharge(self) - Parent of this charge sub-component.
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, variablePortion=0.0, kind='other', ConsumptionTariffIntervals=None, TimeTariffIntervals=None, AuxiliaryAccounts=None, ChildCharges=None, fixedPortion=None, ParentCharge=None, *args, **kw_args) (Constructor)

_attr_types

_many_refs

_refs

AuxiliaryAccounts

ChildCharges

ConsumptionTariffIntervals

ParentCharge

TimeTariffIntervals

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