Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

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 More...
 
 Timeouter (bool t)
 timeout is turned off (false) or on (true) (with 0 second) More...
 
 Timeouter (const Timeouter &t)
 
 Timeouter (double t)
 timeout is set to the given value (seconds) More...
 
 ~Timeouter ()
 
bool isTimeLimit () const
 returns whether any time limit is set or not More...
 
Timeouteroperator= (const Timeouter &t)
 
double timeLimit () const
 returns the current time limit for the call More...
 
void timeLimit (bool t)
 shorthand to turn timelimit off or on (with 0 seconds) More...
 
void timeLimit (double t)
 sets the time limit for the call (in seconds); <0 means no limit. More...
 

Protected Attributes

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

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 47 of file Timeouter.h.

Constructor & Destructor Documentation

◆ Timeouter() [1/4]

ogdf::Timeouter::Timeouter ( )
inline

timeout is turned of by default

Definition at line 51 of file Timeouter.h.

◆ Timeouter() [2/4]

ogdf::Timeouter::Timeouter ( double  t)
inlineexplicit

timeout is set to the given value (seconds)

Definition at line 54 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 57 of file Timeouter.h.

◆ Timeouter() [4/4]

ogdf::Timeouter::Timeouter ( const Timeouter t)
inline

Definition at line 59 of file Timeouter.h.

◆ ~Timeouter()

ogdf::Timeouter::~Timeouter ( )
inline

Definition at line 61 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 84 of file Timeouter.h.

◆ operator=()

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

Definition at line 63 of file Timeouter.h.

◆ timeLimit() [1/3]

double ogdf::Timeouter::timeLimit ( ) const
inline

returns the current time limit for the call

Definition at line 79 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 74 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 69 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 89 of file Timeouter.h.


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