ogdf::DinoUmlDiagramGraph Class Reference

#include <ogdf/fileformats/DinoUmlDiagramGraph.h>

List of all members.

Public Types
enum	UmlDiagramType {   classDiagram, moduleDiagram, sequenceDiagram, collaborationDiagram,   componentDiagram, unknownDiagram }
Public Member Functions
	DinoUmlDiagramGraph (const DinoUmlModelGraph &umlModelGraph, UmlDiagramType diagramType, String diagramName)
	~DinoUmlDiagramGraph ()
void	addNodeWithGeometry (NodeElement *node, double x, double y, double w, double h)
void	addEdge (EdgeElement *edge)
String	getDiagramName () const
String	getDiagramTypeString () const
const SList< NodeElement * > &	getNodes () const
const SList< EdgeElement * > &	getEdges () const
const SList< double > &	getX () const
const SList< double > &	getY () const
const SList< double > &	getWidth () const
const SList< double > &	getHeight () const
Private Attributes
const DinoUmlModelGraph &	m_modelGraph
String	m_diagramName
UmlDiagramType	m_diagramType
SList< NodeElement * >	m_containedNodes
SList< EdgeElement * >	m_containedEdges
SList< double >	m_x
SList< double >	m_y
SList< double >	m_w
SList< double >	m_h
Friends
ostream &	operator<< (ostream &, const DinoUmlDiagramGraph &)

---

Detailed Description

Contains the class DinoUmlDiagramGraph which represents one particular diagram of the complete UML Model. Each diagram refers to the node and edge information of DinoUmlModelGraph. Essentially a diagram contains selected nodes and edges of the model provides with additional geometric information.

Definition at line 77 of file DinoUmlDiagramGraph.h.

---

Member Enumeration Documentation

enum ogdf::DinoUmlDiagramGraph::UmlDiagramType

This enum type represents the different diagram types of UML.

Enumerator:

classDiagram
moduleDiagram
sequenceDiagram
collaborationDiagram
componentDiagram
unknownDiagram

Definition at line 77 of file DinoUmlDiagramGraph.h.

---

Constructor & Destructor Documentation

ogdf::DinoUmlDiagramGraph::DinoUmlDiagramGraph	(	const DinoUmlModelGraph &	umlModelGraph,
		UmlDiagramType	diagramType,
		String	diagramName
	)

Constructor.

ogdf::DinoUmlDiagramGraph::~DinoUmlDiagramGraph

(

)

Destructor.

---

Member Function Documentation

void ogdf::DinoUmlDiagramGraph::addEdge

(

EdgeElement *

edge

)

Adds an edge.

void ogdf::DinoUmlDiagramGraph::addNodeWithGeometry	(	NodeElement *	node,
		double	x,
		double	y,
		double	w,
		double	h
	)

Adds a node with the given coordinates.

String ogdf::DinoUmlDiagramGraph::getDiagramName

(

)

const [inline]

Returns the name of the diagram.

Definition at line 146 of file DinoUmlDiagramGraph.h.

String ogdf::DinoUmlDiagramGraph::getDiagramTypeString

(

)

const

Returns the type of the diagram as string.

const SList<EdgeElement*>& ogdf::DinoUmlDiagramGraph::getEdges

(

)

const [inline]

Access to contained edges.

Definition at line 159 of file DinoUmlDiagramGraph.h.

const SList<double>& ogdf::DinoUmlDiagramGraph::getHeight

(

)

const [inline]

Access to height.

Definition at line 179 of file DinoUmlDiagramGraph.h.

const SList<NodeElement*>& ogdf::DinoUmlDiagramGraph::getNodes

(

)

const [inline]

Access to contained nodes.

Definition at line 154 of file DinoUmlDiagramGraph.h.

const SList<double>& ogdf::DinoUmlDiagramGraph::getWidth

(

)

const [inline]

Access to width.

Definition at line 174 of file DinoUmlDiagramGraph.h.

const SList<double>& ogdf::DinoUmlDiagramGraph::getX

(

)

const [inline]

Access to x-coordinates.

Definition at line 164 of file DinoUmlDiagramGraph.h.

const SList<double>& ogdf::DinoUmlDiagramGraph::getY

(

)

const [inline]

Access to y-coordinates.

Definition at line 169 of file DinoUmlDiagramGraph.h.

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	,
		const DinoUmlDiagramGraph &
	)			[friend]

Output operator for DinoUmlDiagramGraph.

---

Member Data Documentation

SList<EdgeElement*> ogdf::DinoUmlDiagramGraph::m_containedEdges [private]

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

Definition at line 106 of file DinoUmlDiagramGraph.h.

SList<NodeElement*> ogdf::DinoUmlDiagramGraph::m_containedNodes [private]

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

Definition at line 101 of file DinoUmlDiagramGraph.h.

String ogdf::DinoUmlDiagramGraph::m_diagramName [private]

The name of the diagram.

Definition at line 93 of file DinoUmlDiagramGraph.h.

UmlDiagramType ogdf::DinoUmlDiagramGraph::m_diagramType [private]

The type of diagram.

Definition at line 96 of file DinoUmlDiagramGraph.h.

SList<double> ogdf::DinoUmlDiagramGraph::m_h [private]

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

Definition at line 126 of file DinoUmlDiagramGraph.h.

const DinoUmlModelGraph& ogdf::DinoUmlDiagramGraph::m_modelGraph [private]

Reference to the model graph.

Definition at line 90 of file DinoUmlDiagramGraph.h.

SList<double> ogdf::DinoUmlDiagramGraph::m_w [private]

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

Definition at line 121 of file DinoUmlDiagramGraph.h.

SList<double> ogdf::DinoUmlDiagramGraph::m_x [private]

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

Definition at line 111 of file DinoUmlDiagramGraph.h.

SList<double> ogdf::DinoUmlDiagramGraph::m_y [private]

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

Definition at line 116 of file DinoUmlDiagramGraph.h.

---

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

• ogdf/fileformats/DinoUmlDiagramGraph.h