The Base class for simultaneous graph drawing.
More...
#include <ogdf/simultaneous/SimDraw.h>
List of all members.
Public Types |
| enum | CompareBy { index,
label
} |
| | Types for node comparison.
More...
|
Public Member Functions |
| | SimDraw () |
| | constructs empty simdraw instance
|
| const Graph & | constGraph () const |
| | returns graph
|
| Graph & | constGraph () |
| | returns graph
|
| const GraphAttributes & | constGraphAttributes () const |
| | returns graphattributes
|
| GraphAttributes & | constGraphAttributes () |
| | returns graphattributes
|
| void | clear () |
| | empty graph
|
| const CompareBy & | compareBy () const |
| | returns compare mode
|
| CompareBy & | compareBy () |
| | returns compare mode
|
| const bool & | isDummy (node v) const |
| | returns true if node v is marked as dummy
|
| bool & | isDummy (node v) |
| | returns true if node v is marked as dummy
|
| bool | isPhantomDummy (node v) const |
| | returns true if node v is a cost zero dummy node
|
| bool | isProperDummy (node v) const |
| | returns true if node v is a cost greater zero dummy node
|
| int | numberOfNodes () const |
| | returns number of nodes
|
| int | numberOfDummyNodes () const |
| | returns number of dummy nodes
|
| int | numberOfPhantomDummyNodes () const |
| | returns number of phantom dummy nodes
|
| int | numberOfProperDummyNodes () const |
| | returns number of proper dummy nodes
|
| bool | consistencyCheck () const |
| | checks whether instance is a consistent SimDraw instance
|
| int | maxSubGraph () const |
| | calculates maximum number of input graphs
|
| int | numberOfBasicGraphs () const |
| | returns number of BasicGraphs in m_G
|
| void | readGML (const char *fileName) |
| | calls GraphAttributes::readGML
|
| void | writeGML (const char *fileName) const |
| | calls GraphAttributes::writeGML
|
| const Graph | getBasicGraph (int i) const |
| | returns graph consisting of all edges and nodes from SubGraph i
|
| void | getBasicGraphAttributes (int i, GraphAttributes &GA, Graph &G) |
| | returns graphattributes associated with basic graph i
|
| bool | addGraphAttributes (const GraphAttributes &GA) |
| | adds new GraphAttributes to m_G
|
| bool | addGraph (const Graph &G) |
| | adds the graph g to the instance m_G
|
| void | addAttribute (long attr) |
| | gives access to new attribute if not already given
|
Private Member Functions |
| bool | compareById (node v, node w) const |
| | compares two nodes v and w by their ids
|
| bool | compareByLabel (const GraphAttributes &vGA, node v, const GraphAttributes &wGA, node w) const |
| | compares two nodes v and w by their labels
|
| bool | compare (const GraphAttributes &vGA, node v, const GraphAttributes &wGA, node w) const |
| | compares two nodes v and w by compare mode stored in m_compareBy
|
Private Attributes |
| Graph | m_G |
| | the underlying graph
|
| GraphAttributes | m_GA |
| | the underlying graphattributes
|
| CompareBy | m_compareBy |
| | compare mode
|
| NodeArray< bool > | m_isDummy |
| | dummy nodes may be colored differently
|
Friends |
| class | SimDrawManipulatorModule |
| class | SimDrawCaller |
| class | SimDrawColorizer |
| class | SimDrawCreator |
| class | SimDrawCreatorSimple |
Detailed Description
The Base class for simultaneous graph drawing.
This class provides functions for simultaneous graph drawing, such as adding new subgraphs.
It is possible to store up to 32 basicgraphs in one instance of the class. The basic graph membership for all edges is stored via GraphAttributes::edgeSubgraph. Several functions are outsourced in corresponding manipulator modules.
Definition at line 72 of file SimDraw.h.
Member Enumeration Documentation
Types for node comparison.
- Enumerator:
| index |
nodes are compared by their indices
|
| label |
nodes are compared by their labels
|
Definition at line 82 of file SimDraw.h.
Constructor & Destructor Documentation
| ogdf::SimDraw::SimDraw |
( |
|
) |
|
Member Function Documentation
| void ogdf::SimDraw::addAttribute |
( |
long |
attr |
) |
[inline] |
gives access to new attribute if not already given
Definition at line 203 of file SimDraw.h.
| bool ogdf::SimDraw::addGraph |
( |
const Graph & |
G |
) |
|
adds the graph g to the instance m_G
If the number of subgraphs in m_G is less than 32 and m_compareBy is set to index, this function will add graph G to m_G and return true. Otherwise this function returns false.
adds new GraphAttributes to m_G
If the number of subgraphs in m_G is less than 32, this function will add the new GraphAttributes GA to m_G and return true. Otherwise this function returns false. The function uses the current compare mode.
| void ogdf::SimDraw::clear |
( |
|
) |
[inline] |
compares two nodes v and w by compare mode stored in m_compareBy
This method checks whether m_compareBy was set to index or label and uses the corresponding compare method.
| const CompareBy& ogdf::SimDraw::compareBy |
( |
|
) |
const [inline] |
returns compare mode
Definition at line 116 of file SimDraw.h.
| CompareBy& ogdf::SimDraw::compareBy |
( |
|
) |
[inline] |
returns compare mode
Definition at line 122 of file SimDraw.h.
| bool ogdf::SimDraw::compareById |
( |
node |
v, |
|
|
node |
w | |
|
) |
| | const [inline, private] |
compares two nodes v and w by their ids
Definition at line 211 of file SimDraw.h.
compares two nodes v and w by their labels
This method only works, if attribute nodeLabel is activated and set properly. Otherwise it is recommended to use compareById.
Definition at line 219 of file SimDraw.h.
| bool ogdf::SimDraw::consistencyCheck |
( |
|
) |
const |
checks whether instance is a consistent SimDraw instance
| const Graph& ogdf::SimDraw::constGraph |
( |
|
) |
const [inline] |
| Graph& ogdf::SimDraw::constGraph |
( |
|
) |
[inline] |
returns graphattributes
Definition at line 110 of file SimDraw.h.
| const GraphAttributes& ogdf::SimDraw::constGraphAttributes |
( |
|
) |
const [inline] |
returns graphattributes
Definition at line 108 of file SimDraw.h.
| const Graph ogdf::SimDraw::getBasicGraph |
( |
int |
i |
) |
const |
returns graph consisting of all edges and nodes from SubGraph i
returns graphattributes associated with basic graph i
Supported attributes are: nodeGraphics, edgeGraphics, edgeLabel, nodeLabel, nodeId, edgeIntWeight and edgeColor.
| const bool& ogdf::SimDraw::isDummy |
( |
node |
v |
) |
const [inline] |
returns true if node v is marked as dummy
All dummy node features are introduced for usage when running callSubgraphPlanarizer of SimDrawCaller.
Definition at line 129 of file SimDraw.h.
| bool& ogdf::SimDraw::isDummy |
( |
node |
v |
) |
[inline] |
returns true if node v is marked as dummy
Definition at line 131 of file SimDraw.h.
| bool ogdf::SimDraw::isPhantomDummy |
( |
node |
v |
) |
const [inline] |
returns true if node v is a cost zero dummy node
Definition at line 133 of file SimDraw.h.
| bool ogdf::SimDraw::isProperDummy |
( |
node |
v |
) |
const |
returns true if node v is a cost greater zero dummy node
| int ogdf::SimDraw::maxSubGraph |
( |
|
) |
const |
calculates maximum number of input graphs
Subgraphs are numbered from 0 to 31. This method returns the number of the maximal used subgraph. If the graph is empty, the function returns -1.
| int ogdf::SimDraw::numberOfBasicGraphs |
( |
|
) |
const |
returns number of BasicGraphs in m_G
This function uses maxSubGraph to return the number of basic graphs contained in m_G. If the graph is empty, the function returns 0.
| int ogdf::SimDraw::numberOfDummyNodes |
( |
|
) |
const |
returns number of dummy nodes
| int ogdf::SimDraw::numberOfNodes |
( |
|
) |
const [inline] |
returns number of nodes
Definition at line 141 of file SimDraw.h.
| int ogdf::SimDraw::numberOfPhantomDummyNodes |
( |
|
) |
const |
returns number of phantom dummy nodes
| int ogdf::SimDraw::numberOfProperDummyNodes |
( |
|
) |
const |
returns number of proper dummy nodes
| void ogdf::SimDraw::readGML |
( |
const char * |
fileName |
) |
[inline] |
| void ogdf::SimDraw::writeGML |
( |
const char * |
fileName |
) |
const [inline] |
Friends And Related Function Documentation
Member Data Documentation
the underlying graph
Definition at line 88 of file SimDraw.h.
the underlying graphattributes
Definition at line 89 of file SimDraw.h.
dummy nodes may be colored differently
Definition at line 91 of file SimDraw.h.
The documentation for this class was generated from the following file: