Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfOperations :: Module TroubleTicket' :: Class TroubleTicket

[frames] | no frames]

Class TroubleTicket

                         object --+            
                                  |            
                   Element'.Element --+        
                                      |        
Core.IdentifiedObject'.IdentifiedObject --+    
                                          |    
         IEC61968.Common.Document'.Document --+
                                              |
                                             TroubleTicket

A document used to report electrical trouble. The trouble may either be an outage or non-outage problem, such as power quality. It must always be associated with an incident record. Note that a separate activity record is created for each call associated with an instance of trouble ticket. The time of a call is stored in 'ActivityRecord.createdOn' and comments are recorded in 'ActivityRecord.remarks'.A document used to report electrical trouble. The trouble may either be an outage or non-outage problem, such as power quality. It must always be associated with an incident record. Note that a separate activity record is created for each call associated with an instance of trouble ticket. The time of a call is stored in 'ActivityRecord.createdOn' and comments are recorded in 'ActivityRecord.remarks'.

Instance Methods

[hide private]

__init__(self, firstCallDateTime='', estimatedRestoreDateTime='', informBeforeRestored=False, reportingKind='email', priority='', informAfterRestored=False, advice='', hazardCode='', callBack=False, CallBacks=None, troublePeriod=None, CustomerData=None, IncidentRecord=None, *args, **kw_args)
Initialises a new 'TroubleTicket' instance.

addCallBacks(self, *CallBacks)

getCallBacks(self)

getCustomerData(self)

getIncidentRecord(self)

removeCallBacks(self, *CallBacks)

setCallBacks(self, value)

setCustomerData(self, value)

setIncidentRecord(self, value)

Inherited from IEC61968.Common.Document'.Document: addActivityRecords, addAssetRoles, addChangeItems, addChangeSets, addErpOrganisationRoles, addErpPersonRoles, addFromDocumentRoles, addMeasurements, addNetworkDataSets, addPowerSystemResourceRoles, addScheduleParameterInfos, addScheduledEvents, addToDocumentRoles, getActivityRecords, getAssetRoles, getChangeItems, getChangeSets, getErpOrganisationRoles, getErpPersonRoles, getFromDocumentRoles, getMeasurements, getNetworkDataSets, getPowerSystemResourceRoles, getScheduleParameterInfos, getScheduledEvents, getToDocumentRoles, removeActivityRecords, removeAssetRoles, removeChangeItems, removeChangeSets, removeErpOrganisationRoles, removeErpPersonRoles, removeFromDocumentRoles, removeMeasurements, removeNetworkDataSets, removePowerSystemResourceRoles, removeScheduleParameterInfos, removeScheduledEvents, removeToDocumentRoles, setActivityRecords, setAssetRoles, setChangeItems, setChangeSets, setErpOrganisationRoles, setErpPersonRoles, setFromDocumentRoles, setMeasurements, setNetworkDataSets, setPowerSystemResourceRoles, setScheduleParameterInfos, setScheduledEvents, setToDocumentRoles

Inherited from 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 = {'advice': <type 'str'>, 'callBack': <type 'bool...

_attrs = ['firstCallDateTime', 'estimatedRestoreDateTime', 'in...

_defaults = {'advice': '', 'callBack': False, 'estimatedRestor...

_enums = {'reportingKind': 'TroubleReportingKind'}

_many_refs = ['CallBacks']

_refs = ['CallBacks', 'troublePeriod', 'CustomerData', 'Incide...

troublePeriod = None

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

Properties

[hide private]

CallBacks

CustomerData

IncidentRecord

Inherited from IEC61968.Common.Document'.Document: ActivityRecords, AssetRoles, ChangeItems, ChangeSets, ErpOrganisationRoles, ErpPersonRoles, FromDocumentRoles, Measurements, NetworkDataSets, PowerSystemResourceRoles, ScheduleParameterInfos, ScheduledEvents, ToDocumentRoles

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

Inherited from object: __class__

Method Details

[hide private]

init(self, firstCallDateTime=`''`, estimatedRestoreDateTime=`''`, informBeforeRestored=False, reportingKind=`'email'`, priority=`''`, informAfterRestored=False, advice=`''`, hazardCode=`''`, callBack=False, CallBacks=None, troublePeriod=None, CustomerData=None, IncidentRecord=None, *args, **kw_args)
(Constructor)

Initialises a new 'TroubleTicket' instance.

Parameters:

firstCallDateTime - Date and time trouble call first received. The date and time of subsequent calls by the same customer for the same trouble are recorded in associated Activity Records.
estimatedRestoreDateTime - Estimated restoration date and time last provided to the customer.
informBeforeRestored - True if person reporting trouble requested a call back when sigificant information became available about cause of the outage and the estimated restoration time. The person and their contact information are maintained in the assoicated Customer information. Call back results are recorded in assoicated 'ActivityRecord.Status.remarks'.
reportingKind - Means the customer used to report trouble (default is 'call'). Values are: "email", "call", "letter", "other"
priority - Priority of trouble call.
informAfterRestored - True if person reporting trouble requested a call back to confirm power has been restored. The person and their contact information is maintained in the assoicated Customer informaiton. Call back results are recorded in assoicated 'ActivityRecord.Status.remarks'.
advice - True if advice already given to the customer at time when trouble was first reported.
hazardCode - Code for a reported hazard condition.
callBack - True if requested to customer when someone is about to arrive at their premises.
CallBacks
troublePeriod - Period between this source of trouble started and was resolved.
CustomerData
IncidentRecord

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'advice': <type 'str'>,
 'callBack': <type 'bool'>,
 'estimatedRestoreDateTime': <type 'str'>,
 'firstCallDateTime': <type 'str'>,
 'hazardCode': <type 'str'>,
 'informAfterRestored': <type 'bool'>,
 'informBeforeRestored': <type 'bool'>,
 'priority': <type 'str'>,
...

_attrs

Value:

['firstCallDateTime',
 'estimatedRestoreDateTime',
 'informBeforeRestored',
 'reportingKind',
 'priority',
 'informAfterRestored',
 'advice',
 'hazardCode',
...

_defaults

Value:

{'advice': '',
 'callBack': False,
 'estimatedRestoreDateTime': '',
 'firstCallDateTime': '',
 'hazardCode': '',
 'informAfterRestored': False,
 'informBeforeRestored': False,
 'priority': '',
...

_refs

Value:

['CallBacks', 'troublePeriod', 'CustomerData', 'IncidentRecord']

Property Details

[hide private]

CallBacks

Get Method:: getCallBacks(self)
Set Method:: setCallBacks(self, value)

CustomerData

Get Method:: getCustomerData(self)
Set Method:: setCustomerData(self, value)

IncidentRecord

Get Method:: getIncidentRecord(self)
Set Method:: setIncidentRecord(self, value)