Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfGMLSupport :: Module Diagram' :: Class Diagram
[hide private]
[frames] | no frames]

Class Diagram

                         object --+            
                                  |            
                   Element'.Element --+        
                                      |        
Core.IdentifiedObject'.IdentifiedObject --+    
                                          |    
         IEC61968.Common.Document'.Document --+
                                              |
                                             Diagram
Known Subclasses:

The Diagram represents the diagram being exchanged. The initialView attributes can be used to specify an initial view with the x,y coordinates of the diagonal points. The coordinate system is a standard Cartesian coordinate system and the orientation attribute defines a positive or negative orientation. A positive orientation gives standard ‘right-hand’ orientation, with negative orientation indicating a ‘left-hand’ orientation. For 2D diagrams, a positive orientation will result in X values increasing from left to right and Y values increasing from bottom to top. A negative orientation gives the ‘left-hand’ orientation (favoured by computer graphics displays) with X values increasing from left to right and Y values increasing from top to bottom.The Diagram represents the diagram being exchanged. The initialView attributes can be used to specify an initial view with the x,y coordinates of the diagonal points. The coordinate system is a standard Cartesian coordinate system and the orientation attribute defines a positive or negative orientation. A positive orientation gives standard ‘right-hand’ orientation, with negative orientation indicating a ‘left-hand’ orientation. For 2D diagrams, a positive orientation will result in X values increasing from left to right and Y values increasing from bottom to top. A negative orientation gives the ‘left-hand’ orientation (favoured by computer graphics displays) with X values increasing from left to right and Y values increasing from top to bottom.

Instance Methods [hide private]
 
__init__(self, y1InitialView=0.0, kind='other', x2InitialView=0.0, x1InitialView=0.0, orientation='negative', y2InitialView=0.0, DiagramObjects=None, CoordinateSystem=None, GmlDiagramObjects=None, DesignLocations=None, *args, **kw_args)
Initialises a new 'Diagram' instance.
 
addDesignLocations(self, *DesignLocations)
 
addDiagramObjects(self, *DiagramObjects)
 
addGmlDiagramObjects(self, *GmlDiagramObjects)
 
getCoordinateSystem(self)
 
getDesignLocations(self)
 
getDiagramObjects(self)
A diagram is made up of multiple DiagramObjects
 
getGmlDiagramObjects(self)
 
removeDesignLocations(self, *DesignLocations)
 
removeDiagramObjects(self, *DiagramObjects)
 
removeGmlDiagramObjects(self, *GmlDiagramObjects)
 
setCoordinateSystem(self, value)
 
setDesignLocations(self, value)
 
setDiagramObjects(self, value)
 
setGmlDiagramObjects(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: addNames, getModelingAuthoritySet, getNames, removeNames, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'kind': <type 'str'>, 'orientation': <type 'str...
  _attrs = ['y1InitialView', 'kind', 'x2InitialView', 'x1Initial...
  _defaults = {'kind': 'other', 'orientation': 'negative', 'x1In...
  _enums = {'kind': 'DiagramKind', 'orientation': 'OrientationKi...
  _many_refs = ['DiagramObjects', 'GmlDiagramObjects', 'DesignLo...
  _refs = ['DiagramObjects', 'CoordinateSystem', 'GmlDiagramObje...

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

Properties [hide private]
  CoordinateSystem
  DesignLocations
  DiagramObjects
A diagram is made up of multiple DiagramObjects
  GmlDiagramObjects

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

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, y1InitialView=0.0, kind='other', x2InitialView=0.0, x1InitialView=0.0, orientation='negative', y2InitialView=0.0, DiagramObjects=None, CoordinateSystem=None, GmlDiagramObjects=None, DesignLocations=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Diagram' instance.

Parameters:
  • y1InitialView - Y coordinate of the first corner of the initial view
  • kind - Kind of this diagram. Values are: "other", "geographic", "internalView", "designSketch", "schematic"
  • x2InitialView - X coordinate of the second corner of the initial view
  • x1InitialView - X coordinate of the first corner of the initial view
  • orientation - The Diagram represents the diagram being exchanged. The initialView attributes can be used to specify an initial view with the x,y coordinates of the diagonal points. The coordinate system is a standard Cartesian coordinate system and the orientation attribute defines a positive or negative orientation. Values are: "negative", "positive"
  • y2InitialView - Y coordinate of the second corner of the initial view
  • DiagramObjects - A diagram is made up of multiple DiagramObjects
  • CoordinateSystem
  • GmlDiagramObjects
  • DesignLocations
Overrides: object.__init__

addDiagramObjects(self, *DiagramObjects)

 
Overrides: Core.IdentifiedObject'.IdentifiedObject.addDiagramObjects

getDiagramObjects(self)

 

A diagram is made up of multiple DiagramObjects

Overrides: Core.IdentifiedObject'.IdentifiedObject.getDiagramObjects

removeDiagramObjects(self, *DiagramObjects)

 
Overrides: Core.IdentifiedObject'.IdentifiedObject.removeDiagramObjects

setDiagramObjects(self, value)

 
Overrides: Core.IdentifiedObject'.IdentifiedObject.setDiagramObjects

Class Variable Details [hide private]

_attr_types

Value:
{'kind': <type 'str'>,
 'orientation': <type 'str'>,
 'x1InitialView': <type 'float'>,
 'x2InitialView': <type 'float'>,
 'y1InitialView': <type 'float'>,
 'y2InitialView': <type 'float'>}

_attrs

Value:
['y1InitialView',
 'kind',
 'x2InitialView',
 'x1InitialView',
 'orientation',
 'y2InitialView']

_defaults

Value:
{'kind': 'other',
 'orientation': 'negative',
 'x1InitialView': 0.0,
 'x2InitialView': 0.0,
 'y1InitialView': 0.0,
 'y2InitialView': 0.0}

_enums

Value:
{'kind': 'DiagramKind', 'orientation': 'OrientationKind'}

_many_refs

Value:
['DiagramObjects', 'GmlDiagramObjects', 'DesignLocations']

_refs

Value:
['DiagramObjects',
 'CoordinateSystem',
 'GmlDiagramObjects',
 'DesignLocations']

Property Details [hide private]

CoordinateSystem

Get Method:
getCoordinateSystem(self)
Set Method:
setCoordinateSystem(self, value)

DesignLocations

Get Method:
getDesignLocations(self)
Set Method:
setDesignLocations(self, value)

DiagramObjects

A diagram is made up of multiple DiagramObjects

Get Method:
getDiagramObjects(self) - A diagram is made up of multiple DiagramObjects
Set Method:
setDiagramObjects(self, value)

GmlDiagramObjects

Get Method:
getGmlDiagramObjects(self)
Set Method:
setGmlDiagramObjects(self, value)