Package CIM15 :: Package IEC61970 :: Package Graphics :: Module VisibilityLayer' :: Class VisibilityLayer
[hide private]
[frames] | no frames]

Class VisibilityLayer

                         object --+        
                                  |        
                   Element'.Element --+    
                                      |    
Core.IdentifiedObject'.IdentifiedObject --+
                                          |
                                         VisibilityLayer

Layers are typically used for grouping diagram objects according to themes and scales. Themes are used to display or hide certain information (e.g., lakes, borders), while scales are used for hiding or displaying information depending on the current zoom level (hide text when it is too small to be read, or when it exceeds the screen size). This is also called de-cluttering. CIM based graphics exchange will support an m:n relationship between diagram objects and layers. It will be the task of the importing system to convert an m:n case into an appropriate 1:n representation if the importing system does not support m:n.Layers are typically used for grouping diagram objects according to themes and scales. Themes are used to display or hide certain information (e.g., lakes, borders), while scales are used for hiding or displaying information depending on the current zoom level (hide text when it is too small to be read, or when it exceeds the screen size). This is also called de-cluttering. CIM based graphics exchange will support an m:n relationship between diagram objects and layers. It will be the task of the importing system to convert an m:n case into an appropriate 1:n representation if the importing system does not support m:n.

Instance Methods [hide private]
 
__init__(self, drawingOrder=0, DiagramObjects=None, *args, **kw_args)
Initialises a new 'VisibilityLayer' instance.
 
addDiagramObjects(self, *DiagramObjects)
 
getDiagramObjects(self)
A visibility layer can contain one or more diagram objects
 
removeDiagramObjects(self, *DiagramObjects)
 
setDiagramObjects(self, value)

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 = {'drawingOrder': <type 'int'>}
  _attrs = ['drawingOrder']
  _defaults = {'drawingOrder': 0}
  _many_refs = ['DiagramObjects']
  _refs = ['DiagramObjects']

Inherited from Element'.Element (private): _enums

Properties [hide private]
  DiagramObjects
A visibility layer can contain one or more diagram objects

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, drawingOrder=0, DiagramObjects=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'VisibilityLayer' instance.

Parameters:
  • drawingOrder - The drawing order for this layer. As with the drawingOrder for diagram objects, the higher the number, the later the layer and the objects within it are rendered.
  • DiagramObjects - A visibility layer can contain one or more diagram objects
Overrides: object.__init__

addDiagramObjects(self, *DiagramObjects)

 
Overrides: Core.IdentifiedObject'.IdentifiedObject.addDiagramObjects

getDiagramObjects(self)

 

A visibility layer can contain one or more diagram objects

Overrides: Core.IdentifiedObject'.IdentifiedObject.getDiagramObjects

removeDiagramObjects(self, *DiagramObjects)

 
Overrides: Core.IdentifiedObject'.IdentifiedObject.removeDiagramObjects

setDiagramObjects(self, value)

 
Overrides: Core.IdentifiedObject'.IdentifiedObject.setDiagramObjects

Property Details [hide private]

DiagramObjects

A visibility layer can contain one or more diagram objects

Get Method:
getDiagramObjects(self) - A visibility layer can contain one or more diagram objects
Set Method:
setDiagramObjects(self, value)