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
|
/*
* $Revision: 3188 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2013-01-10 09:53:32 +0100 (Thu, 10 Jan 2013) $
***************************************************************/
/** \file
* \brief Declaration of parameterized class for module options
*
* \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_MODULE_OPTION_H
#define OGDF_MODULE_OPTION_H
#include <ogdf/basic/basic.h>
namespace ogdf {
/**
* \brief The parameterized base class for module options.
*
* M is type (base class) of corresponding module. Notice that module
* instances passed to set() must be allocated with new and will be
* freed by ModuleOption.
*/
template<class M> class ModuleOption {
M *m_pModule; //!< Pointer to the module.
public:
//! Initializes a module option; the initial module is just a 0-pointer.
ModuleOption() : m_pModule(0) { }
// destruction
~ModuleOption() { delete m_pModule; }
//! Sets the module to \a pM.
/**
* This function will also free the module currently stored by the option.
*/
void set(M *pM) {
delete m_pModule;
m_pModule = pM;
}
//! Returns true iff the option currently stores a module.
bool valid() const { return m_pModule != 0; }
//! Returns a reference to the stored module.
/**
* It is required that the option currently stores a module, i.e.,
* valid() is true.
*/
M &get() const { return *m_pModule; }
};
} // end namespace ogdf
#endif
|
