ogdf::UmlDiagramGraph Class Reference

Contains the class UmlDiagramGraph which represents one particular diagram of the complete UML Model. More...

#include <ogdf/uml/UmlDiagramGraph.h>

Public Types
enum class	UmlDiagramType { classDiagram , moduleDiagram , sequenceDiagram , collaborationDiagram , componentDiagram , unknownDiagram }
	This enum type represents the different diagram types of UML. *‍/. More...

Public Member Functions
	UmlDiagramGraph (const UmlModelGraph &umlModelGraph, UmlDiagramType diagramType, const string &diagramName)
	Constructor.
	~UmlDiagramGraph ()
	Destructor.
void	addEdge (edge umlEdge)
	Adds an edge.
void	addNodeWithGeometry (node umlNode, double x, double y, double w, double h)
	Adds a node with the given coordinates.
const string &	getDiagramName () const
	Returns the name of the diagram.
const char *	getDiagramTypeString () const
	Returns the type of the diagram as string.
const SList< edge > &	getEdges () const
	Access to contained edges.
const SList< double > &	getHeight () const
	Access to height.
const SList< node > &	getNodes () const
	Access to contained nodes.
const SList< double > &	getWidth () const
	Access to width.
const SList< double > &	getX () const
	Access to x-coordinates.
const SList< double > &	getY () const
	Access to y-coordinates.

Private Attributes
SList< edge >	m_containedEdges
	This list holds pointer to the edges contained in the represented diagram.
SList< node >	m_containedNodes
	This list holds pointer to the nodes contained in the represented diagram.
string	m_diagramName
	The name of the diagram.
UmlDiagramType	m_diagramType
	The type of diagram.
SList< double >	m_h
	This list contains the height of the nodes contained in the represented diagram.
const UmlModelGraph &	m_modelGraph
	Reference to the model graph.
SList< double >	m_w
	This list contains the width of the nodes contained in the represented diagram.
SList< double >	m_x
	This list contains the x-coordinates of the nodes contained in the represented diagram.
SList< double >	m_y
	This list contains the y-coordinates of the nodes contained in the represented diagram.

Friends
std::ostream &	operator<< (std::ostream &, const UmlDiagramGraph &)

Detailed Description

Contains the class UmlDiagramGraph which represents one particular diagram of the complete UML Model.

Each diagram refers to the node and edge information of UmlModelGraph. Essentially a diagram contains selected nodes and edges of the model provides with additional geometric information.

Definition at line 51 of file UmlDiagramGraph.h.

Member Enumeration Documentation

UmlDiagramType

enum class ogdf::UmlDiagramGraph::UmlDiagramType

strong

This enum type represents the different diagram types of UML. *‍/.

Enumerator
classDiagram
moduleDiagram
sequenceDiagram
collaborationDiagram
componentDiagram
unknownDiagram

Definition at line 56 of file UmlDiagramGraph.h.

Constructor & Destructor Documentation

UmlDiagramGraph()

ogdf::UmlDiagramGraph::UmlDiagramGraph	(	const UmlModelGraph &	umlModelGraph,
		UmlDiagramType	diagramType,
		const string &	diagramName
	)

Constructor.

~UmlDiagramGraph()

ogdf::UmlDiagramGraph::~UmlDiagramGraph

(

)

Destructor.

Member Function Documentation

addEdge()

void ogdf::UmlDiagramGraph::addEdge

(

edge

umlEdge

)

Adds an edge.

addNodeWithGeometry()

void ogdf::UmlDiagramGraph::addNodeWithGeometry	(	node	umlNode,
		double	x,
		double	y,
		double	w,
		double	h
	)

Adds a node with the given coordinates.

getDiagramName()

const string & ogdf::UmlDiagramGraph::getDiagramName ( ) const

inline

Returns the name of the diagram.

Definition at line 120 of file UmlDiagramGraph.h.

getDiagramTypeString()

const char * ogdf::UmlDiagramGraph::getDiagramTypeString

(

)

const

Returns the type of the diagram as string.

getEdges()

const SList< edge > & ogdf::UmlDiagramGraph::getEdges ( ) const

inline

Access to contained edges.

Definition at line 129 of file UmlDiagramGraph.h.

getHeight()

const SList< double > & ogdf::UmlDiagramGraph::getHeight ( ) const

inline

Access to height.

Definition at line 141 of file UmlDiagramGraph.h.

getNodes()

const SList< node > & ogdf::UmlDiagramGraph::getNodes ( ) const

inline

Access to contained nodes.

Definition at line 126 of file UmlDiagramGraph.h.

getWidth()

const SList< double > & ogdf::UmlDiagramGraph::getWidth ( ) const

inline

Access to width.

Definition at line 138 of file UmlDiagramGraph.h.

getX()

const SList< double > & ogdf::UmlDiagramGraph::getX ( ) const

inline

Access to x-coordinates.

Definition at line 132 of file UmlDiagramGraph.h.

getY()

const SList< double > & ogdf::UmlDiagramGraph::getY ( ) const

inline

Access to y-coordinates.

Definition at line 135 of file UmlDiagramGraph.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  , const UmlDiagramGraph &    )

friend

Member Data Documentation

m_containedEdges

SList<edge> ogdf::UmlDiagramGraph::m_containedEdges

private

This list holds pointer to the edges contained in the represented diagram.

Definition at line 83 of file UmlDiagramGraph.h.

m_containedNodes

SList<node> ogdf::UmlDiagramGraph::m_containedNodes

private

This list holds pointer to the nodes contained in the represented diagram.

Definition at line 78 of file UmlDiagramGraph.h.

m_diagramName

string ogdf::UmlDiagramGraph::m_diagramName

private

The name of the diagram.

Definition at line 70 of file UmlDiagramGraph.h.

m_diagramType

UmlDiagramType ogdf::UmlDiagramGraph::m_diagramType

private

The type of diagram.

Definition at line 73 of file UmlDiagramGraph.h.

m_h

SList<double> ogdf::UmlDiagramGraph::m_h

private

This list contains the height of the nodes contained in the represented diagram.

Definition at line 103 of file UmlDiagramGraph.h.

m_modelGraph

const UmlModelGraph& ogdf::UmlDiagramGraph::m_modelGraph

private

Reference to the model graph.

Definition at line 67 of file UmlDiagramGraph.h.

m_w

SList<double> ogdf::UmlDiagramGraph::m_w

private

This list contains the width of the nodes contained in the represented diagram.

Definition at line 98 of file UmlDiagramGraph.h.

m_x

SList<double> ogdf::UmlDiagramGraph::m_x

private

This list contains the x-coordinates of the nodes contained in the represented diagram.

Definition at line 88 of file UmlDiagramGraph.h.

m_y

SList<double> ogdf::UmlDiagramGraph::m_y

private

This list contains the y-coordinates of the nodes contained in the represented diagram.

Definition at line 93 of file UmlDiagramGraph.h.

---

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

• include/ogdf/uml/UmlDiagramGraph.h