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

Class GmlStroke

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

The element encapsulating the graphical symbolization parameters for linear geometries.The element encapsulating the graphical symbolization parameters for linear geometries.

Instance Methods [hide private]
 
__init__(self, lineCap='', width=0.0, linejoin='', dashArray='', lineStyle='', dashOffset='', opacity=0.0, GmlColour=None, GmlPolygonSymbols=None, GmlMarks=None, GmlSvgParameters=None, GmlLineSymbols=None, *args, **kw_args)
Initialises a new 'GmlStroke' instance.
 
addGmlLineSymbols(self, *GmlLineSymbols)
 
addGmlMarks(self, *GmlMarks)
 
addGmlPolygonSymbols(self, *GmlPolygonSymbols)
 
addGmlSvgParameters(self, *GmlSvgParameters)
 
getGmlColour(self)
 
getGmlLineSymbols(self)
 
getGmlMarks(self)
 
getGmlPolygonSymbols(self)
 
getGmlSvgParameters(self)
 
removeGmlLineSymbols(self, *GmlLineSymbols)
 
removeGmlMarks(self, *GmlMarks)
 
removeGmlPolygonSymbols(self, *GmlPolygonSymbols)
 
removeGmlSvgParameters(self, *GmlSvgParameters)
 
setGmlColour(self, value)
 
setGmlLineSymbols(self, value)
 
setGmlMarks(self, value)
 
setGmlPolygonSymbols(self, value)
 
setGmlSvgParameters(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 = {'dashArray': <type 'str'>, 'dashOffset': <type ...
  _attrs = ['lineCap', 'width', 'linejoin', 'dashArray', 'lineSt...
  _defaults = {'dashArray': '', 'dashOffset': '', 'lineCap': '',...
  _many_refs = ['GmlPolygonSymbols', 'GmlMarks', 'GmlSvgParamete...
  _refs = ['GmlColour', 'GmlPolygonSymbols', 'GmlMarks', 'GmlSvg...

Inherited from Element'.Element (private): _enums

Properties [hide private]
  GmlColour
  GmlLineSymbols
  GmlMarks
  GmlPolygonSymbols
  GmlSvgParameters

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, lineCap='', width=0.0, linejoin='', dashArray='', lineStyle='', dashOffset='', opacity=0.0, GmlColour=None, GmlPolygonSymbols=None, GmlMarks=None, GmlSvgParameters=None, GmlLineSymbols=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'GmlStroke' instance.

Parameters:
  • lineCap - Enumerated values telling how line strings should be capped (at the two ends of the line string). The values are represented as content strings. The allowed values for line cap are 'butt', 'round', and 'square'. The default values are system-dependent.
  • width - The absolute width (thickness) of a stroke in pixels encoded as a float. The default is 1.0. Fractional numbers are allowed (with a system-dependent interpretation) but negative numbers are not.
  • linejoin - Enumerated values telling how line strings should be joined (between line segments). The values are represented as content strings. The allowed values for line join are 'mitre', 'round', and 'bevel'. The default values are system-dependent.
  • dashArray - Encodes a dash pattern as a series of space separated floats. The first number gives the length in pixels of dash to draw, the second gives the amount of space to leave, and this pattern repeats. If an odd number of values is given, then the pattern is expanded by repeating it twice to give an even number of values. Decimal values have a system-dependent interpretation (usually depending on whether antialiasing is being used). The default is to draw an unbroken line.
  • lineStyle - The name of a defined line style. Usually will be an enumerated value and will be system-specific.
  • dashOffset - Specifies the distance as a float into the 'stroke-dasharray' pattern at which to start drawing.
  • opacity - Specifies the level of translucency to use when rendering the stroke. 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
  • GmlColour
  • GmlPolygonSymbols
  • GmlMarks
  • GmlSvgParameters
  • GmlLineSymbols
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'dashArray': <type 'str'>,
 'dashOffset': <type 'str'>,
 'lineCap': <type 'str'>,
 'lineStyle': <type 'str'>,
 'linejoin': <type 'str'>,
 'opacity': <type 'float'>,
 'width': <type 'float'>}

_attrs

Value:
['lineCap',
 'width',
 'linejoin',
 'dashArray',
 'lineStyle',
 'dashOffset',
 'opacity']

_defaults

Value:
{'dashArray': '',
 'dashOffset': '',
 'lineCap': '',
 'lineStyle': '',
 'linejoin': '',
 'opacity': 0.0,
 'width': 0.0}

_many_refs

Value:
['GmlPolygonSymbols',
 'GmlMarks',
 'GmlSvgParameters',
 'GmlLineSymbols']

_refs

Value:
['GmlColour',
 'GmlPolygonSymbols',
 'GmlMarks',
 'GmlSvgParameters',
 'GmlLineSymbols']

Property Details [hide private]

GmlColour

Get Method:
getGmlColour(self)
Set Method:
setGmlColour(self, value)

GmlLineSymbols

Get Method:
getGmlLineSymbols(self)
Set Method:
setGmlLineSymbols(self, value)

GmlMarks

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

GmlPolygonSymbols

Get Method:
getGmlPolygonSymbols(self)
Set Method:
setGmlPolygonSymbols(self, value)

GmlSvgParameters

Get Method:
getGmlSvgParameters(self)
Set Method:
setGmlSvgParameters(self, value)