# Copyright (C) 2010-2011 Richard Lincoln
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

from CIM15.IEC61968.Common.Document import Document

class OutageReport(Document):
    """Document with statistics of an outage.Document with statistics of an outage.
    """

    def __init__(self, customerCount=0, averageCml=0.0, outageDuration=0.0, totalCml=0.0, OutageRecord=None, OutageHistory=None, *args, **kw_args):
        """Initialises a new 'OutageReport' instance.

        @param customerCount: Total number of outaged customers. 
        @param averageCml: Average Customer Minutes Lost (CML) for this outage. 
        @param outageDuration: Total outage duration. 
        @param totalCml: Total Customer Minutes Lost (CML). 
        @param OutageRecord: reference to related document
        @param OutageHistory: OutageHistory of a customer, which may include this OutageReport.
        """
        #: Total number of outaged customers.
        self.customerCount = customerCount

        #: Average Customer Minutes Lost (CML) for this outage.
        self.averageCml = averageCml

        #: Total outage duration.
        self.outageDuration = outageDuration

        #: Total Customer Minutes Lost (CML).
        self.totalCml = totalCml

        self._OutageRecord = None
        self.OutageRecord = OutageRecord

        self._OutageHistory = None
        self.OutageHistory = OutageHistory

        super(OutageReport, self).__init__(*args, **kw_args)

    _attrs = ["customerCount", "averageCml", "outageDuration", "totalCml"]
    _attr_types = {"customerCount": int, "averageCml": float, "outageDuration": float, "totalCml": float}
    _defaults = {"customerCount": 0, "averageCml": 0.0, "outageDuration": 0.0, "totalCml": 0.0}
    _enums = {}
    _refs = ["OutageRecord", "OutageHistory"]
    _many_refs = []

    def getOutageRecord(self):
        """reference to related document
        """
        return self._OutageRecord

    def setOutageRecord(self, value):
        if self._OutageRecord is not None:
            self._OutageRecord._OutageReport = None

        self._OutageRecord = value
        if self._OutageRecord is not None:
            self._OutageRecord.OutageReport = None
            self._OutageRecord._OutageReport = self

    OutageRecord = property(getOutageRecord, setOutageRecord)

    def getOutageHistory(self):
        """OutageHistory of a customer, which may include this OutageReport.
        """
        return self._OutageHistory

    def setOutageHistory(self, value):
        if self._OutageHistory is not None:
            filtered = [x for x in self.OutageHistory.OutageReports if x != self]
            self._OutageHistory._OutageReports = filtered

        self._OutageHistory = value
        if self._OutageHistory is not None:
            if self not in self._OutageHistory._OutageReports:
                self._OutageHistory._OutageReports.append(self)

    OutageHistory = property(getOutageHistory, setOutageHistory)

