Edge

class understand.Edge

Bases: object

Graph plugin edge object

An edge in a graph. Edges are created from Graph objects with edge. Graphviz attributes can be set. Use sync to associate entities, references, or locations with the edge.

Methods Summary

set	Set edge attribute.
sync	Sync edge to a reference, entities, or file location.

Methods Documentation

set(name, value) → None

Set edge attribute.

Parameters:

• name (str) – the attribute name

• value (str) – the attribute value

Return type:

None

Refer to Graphviz for available attributes.

sync(ref) → None

sync(arch) → None

sync(ent[, comparison_ent]) → None

sync(file[, line[, column]]) → None

Sync edge to a reference, entities, or file location.

Parameters:

• ref (understand.Ref) – a reference to sync

• arch (understand.Arch) – an architecture to sync

• ent (understand.Ent) – an entity to sync

• comparison_ent (understand.Ent or None) – optional, an entity from the comparison database

• file (understand.Ent or str) – a file entity or file path

• line (int or None) – optional, a line number

• column (int or None) – optional, a column number

Return type:

None

Line and column numbers are 1-based.