Trees       Indices       Help   
PyCIM
Package CIM15 :: Package IEC61970 :: Package Graphics :: Module DiagramObject' :: Class DiagramObject
[hide private]
[frames] | no frames]

Class DiagramObject

                         object --+        
                                  |        
                   Element'.Element --+    
                                      |    
Core.IdentifiedObject'.IdentifiedObject --+
                                          |
                                         DiagramObject
Known Subclasses:

This class defines an object that defines one or more points in a given space. This object can be associated with anything that subclasses Identified Object in IEC 61970-301This class defines an object that defines one or more points in a given space. This object can be associated with anything that subclasses Identified Object in IEC 61970-301

Instance Methods [hide private]
 
__init__(self, offsetY=0.0, offsetX=0.0, isPolygon=False, rotation=0.0, drawingOrder=0, VisibilityLayers=None, IdentifiedObject=None, DiagramObjectStyle=None, DiagramObjectPoints=None, Diagram=None, *args, **kw_args)
Initialises a new 'DiagramObject' instance.
 
addDiagramObjectPoints(self, *DiagramObjectPoints)
 
addVisibilityLayers(self, *VisibilityLayers)
 
getDiagram(self)
A diagram object is part of a Diagram
 
getDiagramObjectPoints(self)
A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons)
 
getDiagramObjectStyle(self)
A diagram object has a style associated that provides a reference for the style used in the originating system
 
getIdentifiedObject(self)
The domain object that this diagram object is associated with
 
getVisibilityLayers(self)
A diagram object can be part of multiple visibility layers
 
removeDiagramObjectPoints(self, *DiagramObjectPoints)
 
removeVisibilityLayers(self, *VisibilityLayers)
 
setDiagram(self, value)
 
setDiagramObjectPoints(self, value)
 
setDiagramObjectStyle(self, value)
 
setIdentifiedObject(self, value)
 
setVisibilityLayers(self, value)

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 = {'drawingOrder': <type 'int'>, 'isPolygon': <typ...
  _attrs = ['offsetY', 'offsetX', 'isPolygon', 'rotation', 'draw...
  _defaults = {'drawingOrder': 0, 'isPolygon': False, 'offsetX':...
  _many_refs = ['VisibilityLayers', 'DiagramObjectPoints']
  _refs = ['VisibilityLayers', 'IdentifiedObject', 'DiagramObjec...

Inherited from Element'.Element (private): _enums

Properties [hide private]
  Diagram
A diagram object is part of a Diagram
  DiagramObjectPoints
A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons)
  DiagramObjectStyle
A diagram object has a style associated that provides a reference for the style used in the originating system
  IdentifiedObject
The domain object that this diagram object is associated with
  VisibilityLayers
A diagram object can be part of multiple visibility layers

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, offsetY=0.0, offsetX=0.0, isPolygon=False, rotation=0.0, drawingOrder=0, VisibilityLayers=None, IdentifiedObject=None, DiagramObjectStyle=None, DiagramObjectPoints=None, Diagram=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'DiagramObject' instance.

Parameters:
  • offsetY - The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis.
  • offsetX - The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right.
  • isPolygon - Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected.
  • rotation - Sets the angle of rotation (in Degrees) of the diagram object in a clockwise direction from the normal
  • drawingOrder - The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order.
  • VisibilityLayers - A diagram object can be part of multiple visibility layers
  • IdentifiedObject - The domain object that this diagram object is associated with
  • DiagramObjectStyle - A diagram object has a style associated that provides a reference for the style used in the originating system
  • DiagramObjectPoints - A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons)
  • Diagram - A diagram object is part of a Diagram
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'drawingOrder': <type 'int'>,
 'isPolygon': <type 'bool'>,
 'offsetX': <type 'float'>,
 'offsetY': <type 'float'>,
 'rotation': <type 'float'>}

_attrs

Value:
['offsetY', 'offsetX', 'isPolygon', 'rotation', 'drawingOrder']

_defaults

Value:
{'drawingOrder': 0,
 'isPolygon': False,
 'offsetX': 0.0,
 'offsetY': 0.0,
 'rotation': 0.0}

_refs

Value:
['VisibilityLayers',
 'IdentifiedObject',
 'DiagramObjectStyle',
 'DiagramObjectPoints',
 'Diagram']

Property Details [hide private]

Diagram

A diagram object is part of a Diagram

Get Method:
getDiagram(self) - A diagram object is part of a Diagram
Set Method:
setDiagram(self, value)

DiagramObjectPoints

A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons)

Get Method:
getDiagramObjectPoints(self) - A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons)
Set Method:
setDiagramObjectPoints(self, value)

DiagramObjectStyle

A diagram object has a style associated that provides a reference for the style used in the originating system

Get Method:
getDiagramObjectStyle(self) - A diagram object has a style associated that provides a reference for the style used in the originating system
Set Method:
setDiagramObjectStyle(self, value)

IdentifiedObject

The domain object that this diagram object is associated with

Get Method:
getIdentifiedObject(self) - The domain object that this diagram object is associated with
Set Method:
setIdentifiedObject(self, value)

VisibilityLayers

A diagram object can be part of multiple visibility layers

Get Method:
getVisibilityLayers(self) - A diagram object can be part of multiple visibility layers
Set Method:
setVisibilityLayers(self, value)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Jul 2 18:27:46 2011 http://epydoc.sourceforge.net