Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfGMLSupport :: Module GmlGraphic' :: Class GmlGraphic

[frames] | no frames]

Class GmlGraphic

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

A 'graphic symbol' with an inherent shape, color(s), and possibly size. A 'graphic' can be very informally defined as 'a little picture' and can be of either a raster or vector-graphic source type.A 'graphic symbol' with an inherent shape, color(s), and possibly size. A 'graphic' can be very informally defined as 'a little picture' and can be of either a raster or vector-graphic source type.

Instance Methods

[hide private]

__init__(self, rotation=0.0, size=0, symbolID='', minSize=0, opacity=0.0, xScale=0.0, yScale=0.0, GmlMarks=None, GmlPointSymbols=None, *args, **kw_args)
Initialises a new 'GmlGraphic' instance.

addGmlMarks(self, *GmlMarks)

addGmlPointSymbols(self, *GmlPointSymbols)

getGmlMarks(self)

getGmlPointSymbols(self)

removeGmlMarks(self, *GmlMarks)

removeGmlPointSymbols(self, *GmlPointSymbols)

setGmlMarks(self, value)

setGmlPointSymbols(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 = {'minSize': <type 'int'>, 'opacity': <type 'floa...

_attrs = ['rotation', 'size', 'symbolID', 'minSize', 'opacity'...

_defaults = {'minSize': 0, 'opacity': 0.0, 'rotation': 0.0, 's...

_many_refs = ['GmlMarks', 'GmlPointSymbols']

_refs = ['GmlMarks', 'GmlPointSymbols']

Inherited from Element'.Element (private): _enums

Properties

[hide private]

GmlMarks

GmlPointSymbols

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

Inherited from object: __class__

Method Details

[hide private]

init(self, rotation=0.0, size=0, symbolID=`''`, minSize=0, opacity=0.0, xScale=0.0, yScale=0.0, GmlMarks=None, GmlPointSymbols=None, *args, **kw_args)
(Constructor)

Initialises a new 'GmlGraphic' instance.

Parameters:

rotation - Gives the rotation of a graphic in the clockwise direction about its center point in decimal degrees, encoded as a floating-point number. Negative values mean counter-clockwise rotation. The default value is 0.0 (no rotation). Note that there is no connection between source geometry types and rotations; the point used for plotting has no inherent direction. Also, the point within the graphic about which it is rotated is format dependent. If a format does not include an inherent rotation point, then the point of rotation should be the centroid.
size - Gives the absolute size of the graphic in pixels encoded as a floatingpoint number. The default size for an object is context-dependent. Negative values are not allowed.
symbolID - The identifier of the symbol, if not derived from the type of CIM object (PSR, Asset, Organisation, Document, etc.) gmlSymbolPlacement is associated with.
minSize - The minimum symbol size allowed.
opacity - Specifies the level of translucency to use when rendering the Graphic.The value is encoded as a floating-point value between 0.0 and 1.0 with 0.0 representing completely transparent and 1.0 representing completely opaque, with a linear scale of translucency for intermediate values. The default value is 1.0
xScale - Horizontal scaling factor of normal symbol - particularly applicable to busbars if not described through a sequence of gmlPositions (e.g., Busbar).
yScale - Vertical scaling factor of normal symbol - particularly applicable to busbars if not described through a sequence of gmlPositions (e.g., Busbars).
GmlMarks
GmlPointSymbols

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'minSize': <type 'int'>,
 'opacity': <type 'float'>,
 'rotation': <type 'float'>,
 'size': <type 'int'>,
 'symbolID': <type 'str'>,
 'xScale': <type 'float'>,
 'yScale': <type 'float'>}

_attrs

Value:

['rotation',
 'size',
 'symbolID',
 'minSize',
 'opacity',
 'xScale',
 'yScale']

_defaults

Value:

{'minSize': 0,
 'opacity': 0.0,
 'rotation': 0.0,
 'size': 0,
 'symbolID': '',
 'xScale': 0.0,
 'yScale': 0.0}

Property Details

[hide private]

GmlMarks

Get Method:: getGmlMarks(self)
Set Method:: setGmlMarks(self, value)

GmlPointSymbols

Get Method:: getGmlPointSymbols(self)
Set Method:: setGmlPointSymbols(self, value)

Class GmlGraphic

__init__(self, rotation=0.0, size=0, symbolID='', minSize=0, opacity=0.0, xScale=0.0, yScale=0.0, GmlMarks=None, GmlPointSymbols=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

GmlMarks

GmlPointSymbols

init(self, rotation=0.0, size=0, symbolID=`''`, minSize=0, opacity=0.0, xScale=0.0, yScale=0.0, GmlMarks=None, GmlPointSymbols=None, *args, **kw_args)
(Constructor)