ogdf::Timeouter Class Reference

class for timeout funtionality. More...

#include <ogdf/basic/Timeouter.h>

Inheritance diagram for ogdf::Timeouter:

Public Member Functions
	Timeouter ()
	timeout is turned of by default
	Timeouter (bool t)
	timeout is turned off (false) or on (true) (with 0 second)
	Timeouter (const Timeouter &t)
	Timeouter (double t)
	timeout is set to the given value (seconds)
	~Timeouter ()
bool	isTimeLimit () const
	returns whether any time limit is set or not
Timeouter &	operator= (const Timeouter &t)
double	timeLimit () const
	returns the current time limit for the call
void	timeLimit (bool t)
	shorthand to turn timelimit off or on (with 0 seconds)
void	timeLimit (double t)
	sets the time limit for the call (in seconds); <0 means no limit.

Protected Attributes
double	m_timeLimit
	Time limit for module calls (< 0 means no limit).

Detailed Description

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!

Definition at line 46 of file Timeouter.h.

Constructor & Destructor Documentation

Timeouter() [1/4]

ogdf::Timeouter::Timeouter ( )

inline

timeout is turned of by default

Definition at line 49 of file Timeouter.h.

Timeouter() [2/4]

ogdf::Timeouter::Timeouter ( double  t )

inlineexplicit

timeout is set to the given value (seconds)

Definition at line 52 of file Timeouter.h.

Timeouter() [3/4]

ogdf::Timeouter::Timeouter ( bool  t )

inlineexplicit

timeout is turned off (false) or on (true) (with 0 second)

Definition at line 55 of file Timeouter.h.

Timeouter() [4/4]

ogdf::Timeouter::Timeouter ( const Timeouter &  t )

inline

Definition at line 57 of file Timeouter.h.

~Timeouter()

ogdf::Timeouter::~Timeouter ( )

inline

Definition at line 59 of file Timeouter.h.

Member Function Documentation

isTimeLimit()

bool ogdf::Timeouter::isTimeLimit ( ) const

inline

returns whether any time limit is set or not

Definition at line 76 of file Timeouter.h.

operator=()

Timeouter & ogdf::Timeouter::operator= ( const Timeouter &  t )

inline

Definition at line 61 of file Timeouter.h.

timeLimit() [1/3]

double ogdf::Timeouter::timeLimit ( ) const

inline

returns the current time limit for the call

Definition at line 73 of file Timeouter.h.

timeLimit() [2/3]

void ogdf::Timeouter::timeLimit ( bool  t )

inline

shorthand to turn timelimit off or on (with 0 seconds)

Definition at line 70 of file Timeouter.h.

timeLimit() [3/3]

void ogdf::Timeouter::timeLimit ( double  t )

inline

sets the time limit for the call (in seconds); <0 means no limit.

Definition at line 67 of file Timeouter.h.

Member Data Documentation

m_timeLimit

double ogdf::Timeouter::m_timeLimit

protected

Time limit for module calls (< 0 means no limit).

Definition at line 79 of file Timeouter.h.

---

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

• include/ogdf/basic/Timeouter.h