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
|
/*
* $Revision: 3188 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2013-01-10 09:53:32 +0100 (Thu, 10 Jan 2013) $
***************************************************************/
/** \file
* \brief Declares base class for modules with timeout functionality.
*
* \author Markus Chimani
*
* \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_TIMEOUTER_H
#define OGDF_TIMEOUTER_H
#include <ogdf/basic/basic.h>
namespace ogdf {
//! class for timeout funtionality.
/**
*Holds a double value of the timeout time (in seconds).
* Set the value to some negative value (e.g. -1) to turn the timeout
* off. Note that 0 seconds is a perfectly feasible timeout value!
*/
class OGDF_EXPORT Timeouter
{
public:
//! timeout is turned of by default
Timeouter() : m_timeLimit(-1) { }
//! timeout is set to the given value (seconds)
Timeouter(double t) : m_timeLimit(t) { }
//! timeout is turned off (false) or on (true) (with 0 second)
Timeouter(bool t) : m_timeLimit(t ? 0 : -1) { }
Timeouter(const Timeouter &t) : m_timeLimit(t.m_timeLimit) { }
~Timeouter() { }
Timeouter &operator=(const Timeouter &t) {
m_timeLimit = t.m_timeLimit;
return *this;
}
//! sets the time limit for the call (in seconds); <0 means no limit.
void timeLimit(double t) {
m_timeLimit = t;
}
//! shorthand to turn timelimit off or on (with 0 seconds)
void timeLimit(bool t) {
m_timeLimit = t ? 0 : -1;
}
//! returns the current time limit for the call
double timeLimit() const {
return m_timeLimit;
}
//! returns whether any time limit is set or not
bool isTimeLimit() const {
return m_timeLimit >= 0;
}
protected:
double m_timeLimit; //!< Time limit for module calls (< 0 means no limit).
};
} // end namespace ogdf
#endif
|
