Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfAssets :: Module Procedure' :: Class Procedure

Class Procedure

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

A documented procedure for various types of Work or Work Tasks. One or more procedures guide a compatible unit, a standard way of performing a unit of work. The type of procedure is defined in Procedure.type. For example, when type=Inspection, this procedure coupled with Schedule and other information provides the key items of an inspection plan. Another type of Procedure is a Diagnosis. Note that each specific values and settings to be used in a procedure is intended to be described in an instance of ProcedureValue. A maintenance ticket, a type of Work, is generated whenever maintenance is determined to be needed as a result of an inspection or diagnosis.A documented procedure for various types of Work or Work Tasks. One or more procedures guide a compatible unit, a standard way of performing a unit of work. The type of procedure is defined in Procedure.type. For example, when type=Inspection, this procedure coupled with Schedule and other information provides the key items of an inspection plan. Another type of Procedure is a Diagnosis. Note that each specific values and settings to be used in a procedure is intended to be described in an instance of ProcedureValue. A maintenance ticket, a type of Work, is generated whenever maintenance is determined to be needed as a result of an inspection or diagnosis.

Instance Methods

[hide private]

__init__(self, corporateCode='', sequenceNumber='', kind='test', instruction='', ProcedureValues=None, ProcedureDataSets=None, CompatibleUnits=None, Limits=None, *args, **kw_args)
Initialises a new 'Procedure' instance.

addCompatibleUnits(self, *CompatibleUnits)

addLimits(self, *Limits)

addProcedureDataSets(self, *ProcedureDataSets)

addProcedureValues(self, *ProcedureValues)

getCompatibleUnits(self)

getLimits(self)

getProcedureDataSets(self)

getProcedureValues(self)
UserAttributes used to specify procedure values.

removeCompatibleUnits(self, *CompatibleUnits)

removeLimits(self, *Limits)

removeProcedureDataSets(self, *ProcedureDataSets)

removeProcedureValues(self, *ProcedureValues)

setCompatibleUnits(self, value)

setLimits(self, value)

setProcedureDataSets(self, value)

setProcedureValues(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 = {'corporateCode': <type 'str'>, 'instruction': <...

_attrs = ['corporateCode', 'sequenceNumber', 'kind', 'instruct...

_defaults = {'corporateCode': '', 'instruction': '', 'kind': '...

_enums = {'kind': 'ProcedureKind'}

_many_refs = ['ProcedureValues', 'ProcedureDataSets', 'Compati...

_refs = ['ProcedureValues', 'ProcedureDataSets', 'CompatibleUn...

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

Properties

[hide private]

CompatibleUnits

Limits

ProcedureDataSets

ProcedureValues
UserAttributes used to specify procedure values.

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, corporateCode=`''`, sequenceNumber=`''`, kind=`'test'`, instruction=`''`, ProcedureValues=None, ProcedureDataSets=None, CompatibleUnits=None, Limits=None, *args, **kw_args)
(Constructor)

Initialises a new 'Procedure' instance.

Parameters:

corporateCode - Code for this kind of procedure.
sequenceNumber - Sequence number in a sequence of procedures being performed.
kind - Kind of this procedure. Values are: "test", "maintenance", "other", "inspection", "diagnosis"
instruction - The textual description of the procedure, which references instances of ProcedureValue as appropriate.
ProcedureValues - UserAttributes used to specify procedure values. An example is to have an instance for each of the following settings when conducting a test: voltage, current, frequency, temperature specified in 'name' attribute, and the corresponding value and units in 'value' attribute.
ProcedureDataSets
CompatibleUnits
Limits

Overrides: object.__init__

getProcedureValues(self)

UserAttributes used to specify procedure values. An example is to have an instance for each of the following settings when conducting a test: voltage, current, frequency, temperature specified in 'name' attribute, and the corresponding value and units in 'value' attribute.

Class Variable Details

[hide private]

_attr_types

Value:

{'corporateCode': <type 'str'>,
 'instruction': <type 'str'>,
 'kind': <type 'str'>,
 'sequenceNumber': <type 'str'>}

_attrs

Value:

['corporateCode', 'sequenceNumber', 'kind', 'instruction']

_defaults

Value:

{'corporateCode': '',
 'instruction': '',
 'kind': 'test',
 'sequenceNumber': ''}

_many_refs

Value:

['ProcedureValues', 'ProcedureDataSets', 'CompatibleUnits', 'Limits']

_refs

Value:

['ProcedureValues', 'ProcedureDataSets', 'CompatibleUnits', 'Limits']

Property Details

[hide private]

CompatibleUnits

Get Method:: getCompatibleUnits(self)
Set Method:: setCompatibleUnits(self, value)

Limits

Get Method:: getLimits(self)
Set Method:: setLimits(self, value)

ProcedureDataSets

Get Method:: getProcedureDataSets(self)
Set Method:: setProcedureDataSets(self, value)

ProcedureValues

Get Method:: getProcedureValues(self) - UserAttributes used to specify procedure values.
Set Method:: setProcedureValues(self, value)

Class Procedure

__init__(self, corporateCode='', sequenceNumber='', kind='test', instruction='', ProcedureValues=None, ProcedureDataSets=None, CompatibleUnits=None, Limits=None, *args, **kw_args) (Constructor)

getProcedureValues(self)

_attr_types

_attrs

_defaults

_many_refs

_refs

CompatibleUnits

Limits

ProcedureDataSets

ProcedureValues

init(self, corporateCode=`''`, sequenceNumber=`''`, kind=`'test'`, instruction=`''`, ProcedureValues=None, ProcedureDataSets=None, CompatibleUnits=None, Limits=None, *args, **kw_args)
(Constructor)