Module gml :: Class gml_edge
[show private | hide private]
[frames | no frames]

Class gml_edge


Edges contain a number of attributes that describe the source, destination, color, shape etc. of displayable lines. Relevant getters and setters exist for manipulating edge attributes. The render() routine should be used for returning an edge description suitable for inclusion in a GML file.
Method Summary
  __init__(self)
Set the default attributes for the newly created edge.
  __module_test__(self)
Run a few basic tests to ensure the class is working.
Integer get_dst_id(self)
Get the identifier for the edges destination.
Integer get_dst_uid(self)
Get the unique identifier for the edges destination.
String get_g_arrow(self)
Get the arrow type for the edge from the graphics sub-header.
HTML RGB string (ex: #CCFFCC) get_g_fill(self)
Get the fill color of the edge from the graphics sub-header.
Float get_g_line_width(self)
Get the line width for the edge from the graphics sub-header.
Integer get_g_stipple(self)
Get the stipple value for the edge from the graphics sub-header.
String get_g_type(self)
Get the shape for the edge from the graphics sub-header.
Integer get_generalization(self)
Get the generalization value for this edge.
Integer get_src_id(self)
Get the identifier for the edges source.
Integer get_src_uid(self)
Get the unique identifier for the edges source.
String render(self)
Render an edge description suitable for use in a GML file using the set internal attributes.
  set_dst_id(self, id)
Set the identifier for the edges destination.
  set_dst_uid(self, uid)
Set the unique identifier for the edges destination.
  set_g_arrow(self, arrow)
Set the arrow type for the edge in the graphics sub-header.
  set_g_fill(self, color)
Set the fill color of the edge in the graphics sub-header.
  set_g_line_width(self, pixels)
Set the line width for the edge in the graphics sub-header.
  set_g_stipple(self, stipple)
Set the stipple value for the edge in the graphics sub-header.
  set_g_type(self, type)
Set the shape for the edge in the graphics sub-header.
  set_generalization(self, generalization)
Set the generalization value for the edge.
  set_src_id(self, id)
Set the identifier for the edges source.
  set_src_uid(self, uid)
Set the unique identifier for the edges source.

Method Details

__init__(self)
(Constructor)

Set the default attributes for the newly created edge. See the source if you want to modify the default creation values.

__module_test__(self)

Run a few basic tests to ensure the class is working.

get_dst_id(self)

Get the identifier for the edges destination. This identifier can *not* be assumed to be unique. See get_dst_uid().
Returns:
Identifier
           (type=Integer)

get_dst_uid(self)

Get the unique identifier for the edges destination. The dst_id member variable stores the original value from the GML file. The purpose of the UID is to uniquely identify the edge destination among a list of loaded edges that may potentially have overlapping IDs. The parser class will automatically assign an incremented value.
Returns:
Unique identifier
           (type=Integer)

get_g_arrow(self)

Get the arrow type for the edge from the graphics sub-header.
Returns:
Arrow type
           (type=String)

get_g_fill(self)

Get the fill color of the edge from the graphics sub-header.
Returns:
Color
           (type=HTML RGB string (ex: #CCFFCC))

get_g_line_width(self)

Get the line width for the edge from the graphics sub-header.
Returns:
Line width in pixels
           (type=Float)

get_g_stipple(self)

Get the stipple value for the edge from the graphics sub-header.
Returns:
Stipple value
           (type=Integer)

get_g_type(self)

Get the shape for the edge from the graphics sub-header. For the purposes of Process Stalker this value will be "line".
Returns:
Line type
           (type=String)

get_generalization(self)

Get the generalization value for this edge.
Returns:
Generalization
           (type=Integer)

get_src_id(self)

Get the identifier for the edges source. This identifier can *not* be assumed to be unique. See get_src_uid().
Returns:
Identifier
           (type=Integer)

get_src_uid(self)

Get the unique identifier for the edges source. The src_id member variable stores the original value from the GML file. The purpose of the UID is to uniquely identify the edge source among a list of loaded edges that may potentially have overlapping IDs. The parser class will automatically assign an incremented value.
Returns:
Unique identifier
           (type=Integer)

render(self)

Render an edge description suitable for use in a GML file using the set internal attributes.
Returns:
GML edge description
           (type=String)

set_dst_id(self, id)

Set the identifier for the edges destination. This identifier can *not* be assumed to be unique. See set_dst_uid().
Parameters:
id - Identifier
           (type=Integer)

set_dst_uid(self, uid)

Set the unique identifier for the edges destination. The dst_id member variable stores the original value from the GML file. The purpose of the UID is to uniquely identify the edge destination among a list of loaded edges that may potentially have overlapping IDs. The parser class will automatically assign an incremented value.
Parameters:
uid - Unique identifier
           (type=Integer)

set_g_arrow(self, arrow)

Set the arrow type for the edge in the graphics sub-header.
Parameters:
arrow - Arrow type
           (type=String)

set_g_fill(self, color)

Set the fill color of the edge in the graphics sub-header.
Parameters:
color - Color
           (type=HTML RGB string (ex: #CCFFCC))

set_g_line_width(self, pixels)

Set the line width for the edge in the graphics sub-header.
Parameters:
pixels - Line width in pixels
           (type=Float)

set_g_stipple(self, stipple)

Set the stipple value for the edge in the graphics sub-header.
Parameters:
stipple - Stipple value
           (type=Integer)

set_g_type(self, type)

Set the shape for the edge in the graphics sub-header. For the purposes of Process Stalker this value will be "line".
Parameters:
type - Line type
           (type=String)

set_generalization(self, generalization)

Set the generalization value for the edge.
Parameters:
generalization - Generalization value
           (type=Integer)

set_src_id(self, id)

Set the identifier for the edges source. This identifier can *not* be assumed to be unique. See get_src_uid().
Parameters:
id - Identifier
           (type=Integer)

set_src_uid(self, uid)

Set the unique identifier for the edges source. The src_id member variable stores the original value from the GML file. The purpose of the UID is to uniquely identify the edge source among a list of loaded edges that may potentially have overlapping IDs. The parser class will automatically assign an incremented value.
Parameters:
uid - Unique identifier
           (type=Integer)

Generated by Epydoc 2.1 on Tue Jul 05 12:05:31 2005 http://epydoc.sf.net