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

Class AuxiliaryAccount

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

Variable and dynamic part of AuxiliaryAgreement, generally representing the current state of the account related to the outstanding balance defined in AuxiliaryAgreement.

Instance Methods [hide private]
 
__init__(self, balance=0.0, principleAmount=0.0, Charges=None, AuxiliaryAgreement=None, PaymentTransactions=None, lastDebit=None, lastCredit=None, due=None, *args, **kw_args)
Initialises a new 'AuxiliaryAccount' instance.
 
addCharges(self, *Charges)
 
addPaymentTransactions(self, *PaymentTransactions)
 
getAuxiliaryAgreement(self)
Auxiliary agreement regulating this account.
 
getCharges(self)
All charges levied on this account.
 
getPaymentTransactions(self)
All payments against this account.
 
removeCharges(self, *Charges)
 
removePaymentTransactions(self, *PaymentTransactions)
 
setAuxiliaryAgreement(self, value)
 
setCharges(self, value)
 
setPaymentTransactions(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 = {'balance': <type 'float'>, 'principleAmount': <...
  _attrs = ['balance', 'principleAmount']
  _defaults = {'balance': 0.0, 'principleAmount': 0.0}
  _many_refs = ['Charges', 'PaymentTransactions']
  _refs = ['Charges', 'AuxiliaryAgreement', 'PaymentTransactions...
  due = None
  lastCredit = None
  lastDebit = None

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

Inherited from Element'.Element (private): _enums

Properties [hide private]
  AuxiliaryAgreement
Auxiliary agreement regulating this account.
  Charges
All charges levied on this account.
  PaymentTransactions
All payments against this account.

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

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, balance=0.0, principleAmount=0.0, Charges=None, AuxiliaryAgreement=None, PaymentTransactions=None, lastDebit=None, lastCredit=None, due=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'AuxiliaryAccount' instance.

Parameters:
  • balance - The total amount currently remaining on this account that is required to be paid in order to settle the account to zero. This excludes any due amounts not yet paid.
  • principleAmount - The initial principle amount, with which this account was instantiated.
  • Charges - All charges levied on this account.
  • AuxiliaryAgreement - Auxiliary agreement regulating this account.
  • PaymentTransactions - All payments against this account.
  • lastDebit - Details of the last debit transaction performed on this account.
  • lastCredit - Details of the last credit transaction performed on this account.
  • due - Current amounts now due for payment on this account.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'balance': <type 'float'>, 'principleAmount': <type 'float'>}

_refs

Value:
['Charges',
 'AuxiliaryAgreement',
 'PaymentTransactions',
 'lastDebit',
 'lastCredit',
 'due']

Property Details [hide private]

AuxiliaryAgreement

Auxiliary agreement regulating this account.

Get Method:
getAuxiliaryAgreement(self) - Auxiliary agreement regulating this account.
Set Method:
setAuxiliaryAgreement(self, value)

Charges

All charges levied on this account.

Get Method:
getCharges(self) - All charges levied on this account.
Set Method:
setCharges(self, value)

PaymentTransactions

All payments against this account.

Get Method:
getPaymentTransactions(self) - All payments against this account.
Set Method:
setPaymentTransactions(self, value)