Package CIM15 :: Package IEC61968 :: Package PaymentMetering :: Module Shift' :: Class Shift

Class Shift

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

Known Subclasses:

Generally referring to a period of operation or work performed. Whether shift is open/closed can be derived from attributes 'activiryInterval.start' and 'activityInterval.end'. The grand total for receipts (i.e., cumulative total of all actual receipted amounts during this shift; bankable + non-bankable; excludes rounding error totals) can be derived from receipt: =sum(Receipt.receiptAmount) ; includes bankable and non-bankable receipts. Must also reconcile against: =sum(receiptsGrandTotalBankable + receiptsGrandTotalNonBankable). Must also reconcile against ReceiptSummary: =sum(ReceiptSummary.receiptsTotal). The attributes with 'GrandTotal' defined in this class may need to be used when the source data is periodically flushed from the system and then these cannot be derived.Generally referring to a period of operation or work performed. Whether shift is open/closed can be derived from attributes 'activiryInterval.start' and 'activityInterval.end'. The grand total for receipts (i.e., cumulative total of all actual receipted amounts during this shift; bankable + non-bankable; excludes rounding error totals) can be derived from receipt: =sum(Receipt.receiptAmount) ; includes bankable and non-bankable receipts. Must also reconcile against: =sum(receiptsGrandTotalBankable + receiptsGrandTotalNonBankable). Must also reconcile against ReceiptSummary: =sum(ReceiptSummary.receiptsTotal). The attributes with 'GrandTotal' defined in this class may need to be used when the source data is periodically flushed from the system and then these cannot be derived.

Instance Methods

[hide private]

__init__(self, transactionsGrandTotal=0.0, receiptsGrandTotalBankable=0.0, receiptsGrandTotalRounding=0.0, transactionsGrandTotalRounding=0.0, receiptsGrandTotalNonBankable=0.0, activityInterval=None, *args, **kw_args)
Initialises a new 'Shift' instance.

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 = {'receiptsGrandTotalBankable': <type 'float'>, '...

_attrs = ['transactionsGrandTotal', 'receiptsGrandTotalBankabl...

_defaults = {'receiptsGrandTotalBankable': 0.0, 'receiptsGrand...

_many_refs = []

_refs = ['activityInterval']

activityInterval = None

Inherited from Element'.Element (private): _enums

Properties

[hide private]

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

Inherited from object: __class__

Method Details

[hide private]

init(self, transactionsGrandTotal=0.0, receiptsGrandTotalBankable=0.0, receiptsGrandTotalRounding=0.0, transactionsGrandTotalRounding=0.0, receiptsGrandTotalNonBankable=0.0, activityInterval=None, *args, **kw_args)
(Constructor)

Initialises a new 'Shift' instance.

Parameters:

transactionsGrandTotal - Cumulative total of transacted amounts during this shift. Values are obtained from Transaction attributes: =sum(Transaction.transactionAmount). It must also reconcile against TransactionSummary: =sum(TransactionSummary.transactionsTotal).
receiptsGrandTotalBankable - Total of amounts receipted during this shift that can be manually banked (cash and cheques for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = true.
receiptsGrandTotalRounding - Cumulative amount in error due to process rounding not reflected in receiptsGrandTotal. Values are obtained from Receipt attributes: =sum(Receipt.receiptRounding).
transactionsGrandTotalRounding - Cumulative amount in error due to process rounding not reflected in transactionsGandTotal. Values are obtained from Transaction attributes: =sum(Transaction.transactionRounding).
receiptsGrandTotalNonBankable - Total of amounts receipted during this shift that cannot be manually banked (card payments for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = false.
activityInterval - Interval for activity of this shift.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'receiptsGrandTotalBankable': <type 'float'>,
 'receiptsGrandTotalNonBankable': <type 'float'>,
 'receiptsGrandTotalRounding': <type 'float'>,
 'transactionsGrandTotal': <type 'float'>,
 'transactionsGrandTotalRounding': <type 'float'>}

_attrs

Value:

['transactionsGrandTotal',
 'receiptsGrandTotalBankable',
 'receiptsGrandTotalRounding',
 'transactionsGrandTotalRounding',
 'receiptsGrandTotalNonBankable']

_defaults

Value:

{'receiptsGrandTotalBankable': 0.0,
 'receiptsGrandTotalNonBankable': 0.0,
 'receiptsGrandTotalRounding': 0.0,
 'transactionsGrandTotal': 0.0,
 'transactionsGrandTotalRounding': 0.0}

Class Shift

__init__(self, transactionsGrandTotal=0.0, receiptsGrandTotalBankable=0.0, receiptsGrandTotalRounding=0.0, transactionsGrandTotalRounding=0.0, receiptsGrandTotalNonBankable=0.0, activityInterval=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

init(self, transactionsGrandTotal=0.0, receiptsGrandTotalBankable=0.0, receiptsGrandTotalRounding=0.0, transactionsGrandTotalRounding=0.0, receiptsGrandTotalNonBankable=0.0, activityInterval=None, *args, **kw_args)
(Constructor)