Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::UmlModelGraph Class Reference

This class represents the complete UML Model in a graph-like data structure. More...

#include <ogdf/uml/UmlModelGraph.h>

+ Inheritance diagram for ogdf::UmlModelGraph:

Public Member Functions

 UmlModelGraph ()
 Constructor. More...
 
 ~UmlModelGraph ()
 Destructor. More...
 
const string & getNodeLabel (node v) const
 Returns a const reference to the label of the given node. More...
 
string & label (node v)
 Returns a reference to the label of the given node. More...
 
void setModelName (const string &name)
 Sets the name of the model. More...
 
Graph::EdgeTypetype (edge e)
 Returns a reference to the type of the given edge. More...
 
const Graph::EdgeTypetype (edge e) const
 Returns a const reference to the type of the given edge. More...
 
Graph::NodeTypetype (node v)
 Returns a reference to the type of the given node. More...
 
const Graph::NodeTypetype (node v) const
 Returns a const reference to the type of the given node. More...
 
- Public Member Functions inherited from ogdf::Graph
bool empty () const
 Returns true iff the graph is empty, i.e., contains no nodes. More...
 
int numberOfNodes () const
 Returns the number of nodes in the graph. More...
 
int numberOfEdges () const
 Returns the number of edges in the graph. More...
 
int maxNodeIndex () const
 Returns the largest used node index. More...
 
int maxEdgeIndex () const
 Returns the largest used edge index. More...
 
int maxAdjEntryIndex () const
 Returns the largest used adjEntry index. More...
 
int nodeArrayTableSize () const
 Returns the table size of node arrays associated with this graph. More...
 
int edgeArrayTableSize () const
 Returns the table size of edge arrays associated with this graph. More...
 
int adjEntryArrayTableSize () const
 Returns the table size of adjEntry arrays associated with this graph. More...
 
node firstNode () const
 Returns the first node in the list of all nodes. More...
 
node lastNode () const
 Returns the last node in the list of all nodes. More...
 
edge firstEdge () const
 Returns the first edge in the list of all edges. More...
 
edge lastEdge () const
 Returns the last edge in the list of all edges. More...
 
node chooseNode (std::function< bool(node)> includeNode=[](node) { return true;}, bool isFastTest=true) const
 Returns a random node. More...
 
edge chooseEdge (std::function< bool(edge)> includeEdge=[](edge) { return true;}, bool isFastTest=true) const
 Returns a random edge. More...
 
template<class CONTAINER >
void allNodes (CONTAINER &nodeContainer) const
 Returns a container with all nodes of the graph. More...
 
template<class CONTAINER >
void allEdges (CONTAINER &edgeContainer) const
 Returns a container with all edges of the graph. More...
 
node newNode ()
 Creates a new node and returns it. More...
 
node newNode (int index)
 Creates a new node with predefined index and returns it. More...
 
edge newEdge (node v, node w)
 Creates a new edge (v,w) and returns it. More...
 
edge newEdge (node v, node w, int index)
 Creates a new edge (v,w) with predefined index and returns it. More...
 
edge newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=Direction::after)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (node v, adjEntry adjTgt)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
edge newEdge (adjEntry adjSrc, node w)
 Creates a new edge at predefined positions in the adjacency lists. More...
 
virtual void delNode (node v)
 Removes node v and all incident edges from the graph. More...
 
virtual void delEdge (edge e)
 Removes edge e from the graph. More...
 
virtual void clear ()
 Removes all nodes and all edges from the graph. More...
 
void insert (const Graph &G, NodeArray< node > &nodeMap)
 Inserts Graph G as a subgraph into this Graph. More...
 
void insert (const Graph &G)
 Inserts Graph G as a subgraph into this Graph. More...
 
virtual edge split (edge e)
 Splits edge e into two edges introducing a new node. More...
 
void unsplit (node u)
 Undoes a split operation. More...
 
virtual void unsplit (edge eIn, edge eOut)
 Undoes a split operation. More...
 
node splitNode (adjEntry adjStartLeft, adjEntry adjStartRight)
 Splits a node while preserving the order of adjacency entries. More...
 
node contract (edge e, bool keepSelfLoops=false)
 Contracts edge e while preserving the order of adjacency entries. More...
 
void move (edge e, adjEntry adjSrc, Direction dirSrc, adjEntry adjTgt, Direction dirTgt)
 Moves edge e to a different adjacency list. More...
 
void moveTarget (edge e, node w)
 Moves the target node of edge e to node w. More...
 
void moveTarget (edge e, adjEntry adjTgt, Direction dir)
 Moves the target node of edge e to a specific position in an adjacency list. More...
 
void moveSource (edge e, node w)
 Moves the source node of edge e to node w. More...
 
void moveSource (edge e, adjEntry adjSrc, Direction dir)
 Moves the source node of edge e to a specific position in an adjacency list. More...
 
edge searchEdge (node v, node w, bool directed=false) const
 Searches and returns an edge connecting nodes v and w in time O( min(deg(v ), deg(w ))). More...
 
void reverseEdge (edge e)
 Reverses the edge e, i.e., exchanges source and target node. More...
 
void reverseAllEdges ()
 Reverses all edges in the graph. More...
 
template<class NODELIST >
void collapse (NODELIST &nodesToCollapse)
 Collapses all nodes in the list nodesToCollapse to the first node in the list. More...
 
template<class ADJ_ENTRY_LIST >
void sort (node v, const ADJ_ENTRY_LIST &newOrder)
 Sorts the adjacency list of node v according to newOrder. More...
 
void reverseAdjEdges (node v)
 Reverses the adjacency list of v. More...
 
void moveAdj (adjEntry adjMove, Direction dir, adjEntry adjPos)
 Moves adjacency entry adjMove before or after adjPos. More...
 
void moveAdjAfter (adjEntry adjMove, adjEntry adjAfter)
 Moves adjacency entry adjMove after adjAfter. More...
 
void moveAdjBefore (adjEntry adjMove, adjEntry adjBefore)
 Moves adjacency entry adjMove before adjBefore. More...
 
void reverseAdjEdges ()
 Reverses all adjacency lists. More...
 
void swapAdjEdges (adjEntry adj1, adjEntry adj2)
 Exchanges two entries in an adjacency list. More...
 
int genus () const
 Returns the genus of the graph's embedding. More...
 
bool representsCombEmbedding () const
 Returns true iff the graph represents a combinatorial embedding. More...
 
ListIterator< NodeArrayBase * > registerArray (NodeArrayBase *pNodeArray) const
 Registers a node array. More...
 
ListIterator< EdgeArrayBase * > registerArray (EdgeArrayBase *pEdgeArray) const
 Registers an edge array. More...
 
ListIterator< AdjEntryArrayBase * > registerArray (AdjEntryArrayBase *pAdjArray) const
 Registers an adjEntry array. More...
 
ListIterator< GraphObserver * > registerStructure (GraphObserver *pStructure) const
 Registers a graph observer (e.g. a ClusterGraph). More...
 
void unregisterArray (ListIterator< NodeArrayBase * > it) const
 Unregisters a node array. More...
 
void unregisterArray (ListIterator< EdgeArrayBase * > it) const
 Unregisters an edge array. More...
 
void unregisterArray (ListIterator< AdjEntryArrayBase * > it) const
 Unregisters an adjEntry array. More...
 
void unregisterStructure (ListIterator< GraphObserver * > it) const
 Unregisters a graph observer. More...
 
template<class ArrayBase >
void moveRegisterArray (ListIterator< ArrayBase * > it, ArrayBase *pArray) const
 Move the registration it of an graph element array to pArray (used with move semantics for graph element arrays). More...
 
void resetEdgeIdCount (int maxId)
 Resets the edge id count to maxId. More...
 
 Graph ()
 Constructs an empty graph. More...
 
 Graph (const Graph &G)
 Constructs a graph that is a copy of G. More...
 
virtual ~Graph ()
 Destructor. More...
 
Graphoperator= (const Graph &G)
 Assignment operator. More...
 

Private Attributes

EdgeArray< Graph::EdgeTypem_eType
 The types of the contained edges. More...
 
string m_modelName
 The name of the model. More...
 
NodeArray< string > m_nodeLabel
 The label of the contained nodes. More...
 
NodeArray< Graph::NodeTypem_vType
 The types of the contained nodes. More...
 

Additional Inherited Members

- Public Types inherited from ogdf::Graph
enum  EdgeType { EdgeType::association = 0, EdgeType::generalization = 1, EdgeType::dependency = 2 }
 The type of edges (only used in derived classes). More...
 
enum  NodeType { NodeType::vertex = 0, NodeType::dummy = 1, NodeType::generalizationMerger = 2, NodeType::generalizationExpander = 3, NodeType::highDegreeExpander = 4, NodeType::lowDegreeExpander = 5, NodeType::associationClass = 6 }
 The type of nodes. More...
 
using node_iterator = internal::GraphIterator< node >
 Provides a bidirectional iterator to a node in a graph. More...
 
using edge_iterator = internal::GraphIterator< edge >
 Provides a bidirectional iterator to an edge in a graph. More...
 
using adjEntry_iterator = internal::GraphIterator< adjEntry >
 Provides a bidirectional iterator to an entry in an adjacency list. More...
 
- Public Attributes inherited from ogdf::Graph
internal::GraphObjectContainer< NodeElementnodes
 The container containing all node objects. More...
 
internal::GraphObjectContainer< EdgeElementedges
 The container containing all edge objects. More...
 
- Protected Member Functions inherited from ogdf::Graph
void construct (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 
void assign (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 
void constructInitByNodes (const Graph &G, const List< node > &nodeList, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 Constructs a copy of the subgraph of G induced by nodeList. More...
 
void constructInitByActiveNodes (const List< node > &nodeList, const NodeArray< bool > &activeNodes, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 
void constructInitByCC (const CCsInfo &info, int cc, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
 Constructs a copy of connected component cc in info. More...
 

Detailed Description

This class represents the complete UML Model in a graph-like data structure.

Definition at line 41 of file UmlModelGraph.h.

Constructor & Destructor Documentation

◆ UmlModelGraph()

ogdf::UmlModelGraph::UmlModelGraph ( )

Constructor.

◆ ~UmlModelGraph()

ogdf::UmlModelGraph::~UmlModelGraph ( )

Destructor.

Member Function Documentation

◆ getNodeLabel()

const string& ogdf::UmlModelGraph::getNodeLabel ( node  v) const
inline

Returns a const reference to the label of the given node.

Definition at line 72 of file UmlModelGraph.h.

◆ label()

string& ogdf::UmlModelGraph::label ( node  v)
inline

Returns a reference to the label of the given node.

Definition at line 75 of file UmlModelGraph.h.

◆ setModelName()

void ogdf::UmlModelGraph::setModelName ( const string &  name)
inline

Sets the name of the model.

Definition at line 69 of file UmlModelGraph.h.

◆ type() [1/4]

Graph::EdgeType& ogdf::UmlModelGraph::type ( edge  e)
inline

Returns a reference to the type of the given edge.

Definition at line 81 of file UmlModelGraph.h.

◆ type() [2/4]

const Graph::EdgeType& ogdf::UmlModelGraph::type ( edge  e) const
inline

Returns a const reference to the type of the given edge.

Definition at line 78 of file UmlModelGraph.h.

◆ type() [3/4]

Graph::NodeType& ogdf::UmlModelGraph::type ( node  v)
inline

Returns a reference to the type of the given node.

Definition at line 87 of file UmlModelGraph.h.

◆ type() [4/4]

const Graph::NodeType& ogdf::UmlModelGraph::type ( node  v) const
inline

Returns a const reference to the type of the given node.

Definition at line 84 of file UmlModelGraph.h.

Member Data Documentation

◆ m_eType

EdgeArray<Graph::EdgeType> ogdf::UmlModelGraph::m_eType
private

The types of the contained edges.

Types are association or generalization.

Definition at line 53 of file UmlModelGraph.h.

◆ m_modelName

string ogdf::UmlModelGraph::m_modelName
private

The name of the model.

Definition at line 45 of file UmlModelGraph.h.

◆ m_nodeLabel

NodeArray<string> ogdf::UmlModelGraph::m_nodeLabel
private

The label of the contained nodes.

Definition at line 48 of file UmlModelGraph.h.

◆ m_vType

NodeArray<Graph::NodeType> ogdf::UmlModelGraph::m_vType
private

The types of the contained nodes.

Types are vertex, dummy, generalizationMerger

Definition at line 58 of file UmlModelGraph.h.


The documentation for this class was generated from the following file: