1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
* $Revision: 3368 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2013-04-04 20:07:31 +0200 (Thu, 04 Apr 2013) $
***************************************************************/
/** \file
* \brief Declaration of interface for edge insertion algorithms
*
* \author Carsten Gutwenger
*
* \par License:
* This file is part of the Open Graph Drawing Framework (OGDF).
*
* \par
* Copyright (C)<br>
* See README.txt in the root directory of the OGDF installation for details.
*
* \par
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* Version 2 or 3 as published by the Free Software Foundation;
* see the file LICENSE.txt included in the packaging of this file
* for details.
*
* \par
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* \par
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* \see http://www.gnu.org/copyleft/gpl.html
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_UML_EDGE_INSERTION_MODULE_H
#define OGDF_UML_EDGE_INSERTION_MODULE_H
#include <ogdf/planarity/PlanRepLight.h>
#include <ogdf/basic/Logger.h>
#include <ogdf/basic/Module.h>
#include <ogdf/basic/Timeouter.h>
namespace ogdf {
//! Interface for UML edge insertion algorithms.
/**
* UML edge insertion algorithms take care that generalization edges do not cross in the
* resulting planarzation.
*
* \see SubgraphPlanarizerUML
*/
class OGDF_EXPORT UMLEdgeInsertionModule : public Module, public Timeouter {
public:
//! Initializes a UML edge insertion module (default constructor).
UMLEdgeInsertionModule() { }
//! Initializes a UML edge insertion module (copy constructor).
UMLEdgeInsertionModule(const UMLEdgeInsertionModule &eim) : Timeouter(eim) { }
//! Destructor
virtual ~UMLEdgeInsertionModule() { }
//! Returns a new instance of the UML edge insertion module with the same option settings.
virtual UMLEdgeInsertionModule *clone() const = 0;
//! Inserts all edges in \a origEdges into \a pr while avoiding crossings between generalizations.
/**
* @param pr is the input planarized representation and will also receive the result.
* @param origEdges is the array of original edges (edges in the original graph of \a pr)
* that have to be inserted.
* @return the status of the result.
*/
ReturnType call(PlanRepLight &pr, const Array<edge> &origEdges)
{
return doCall(pr, origEdges, 0, 0);
}
//! Inserts all edges in \a origEdges with given costs into \a pr while avoiding crossings between generalizations.
/**
* @param pr is the input planarized representation and will also receive the result.
* @param costOrig is an edge array containing the costs of original edges; edges in
* \a pr without an original edge have zero costs.
* @param origEdges is the array of original edges (edges in the original graph of \a pr) that have to be inserted.
* @return the status of the result.
*/
ReturnType call(PlanRepLight &pr,
const Array<edge> &origEdges,
const EdgeArray<int> &costOrig)
{
return doCall(pr, origEdges, &costOrig, 0);
}
//! Inserts all edges in \a origEdges into \a pr while avoiding crossings between generalizations, optionally costs and subgraphs may be given.
/**
* @param pr is the input planarized representation and will also receive the result.
* @param origEdges is the array of original edges (edges in the original graph of \a pr) that have to be inserted.
* @param pCostOrig is an edge array containing the costs of original edges; edges in \a pr without an original edge have zero costs.
* May be a 0-pointer, in which case all edges have cost 1.
* @param pEdgeSubGraphs points to an edge array specifying to which subgraph an edge belongs.
* May be a 0-poiner, in which case no subgraphs / simultaneous embedding is used.
* @return the status of the result.
*/
ReturnType callEx(
PlanRepLight &pr,
const Array<edge> &origEdges,
const EdgeArray<int> *pCostOrig = 0,
const EdgeArray<__uint32> *pEdgeSubGraphs = 0)
{
return doCall(pr, origEdges, pCostOrig, pEdgeSubGraphs);
}
protected:
//! Actual algorithm call that has to be implemented by derived classes.
/**
* @param pr is the input planarized representation and will also receive the result.
* @param origEdges is the array of original edges (edges in the original graph of \a pr) that have to be inserted.
* @param pCostOrig is an edge array containing the costs of original edges; edges in \a pr without an original edge have zero costs.
* May be a 0-pointer, in which case all edges have cost 1.
* @param pEdgeSubGraphs points to an edge array specifying to which subgraph an edge belongs.
* May be a 0-poiner, in which case no subgraphs / simultaneous embedding is used.
* @return the status of the result.
*/
virtual ReturnType doCall(
PlanRepLight &pr,
const Array<edge> &origEdges,
const EdgeArray<int> *pCostOrig,
const EdgeArray<__uint32> *pEdgeSubGraphs) = 0;
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
