Open
Graph Drawing
Framework

 v.2010.10
 

Public Member Functions | Protected Attributes

ogdf::Timeouter Class Reference

class for timeout funtionality More...

#include <ogdf/basic/Timeouter.h>

Inheritance diagram for ogdf::Timeouter:
ogdf::CPlanarSubgraphModule ogdf::CrossingMinimizationModule ogdf::EdgeInsertionModule ogdf::EmbedderModule ogdf::PlanarSubgraphModule ogdf::MaximumCPlanarSubgraph ogdf::SubgraphPlanarizer ogdf::FixedEmbeddingInserter ogdf::VariableEmbeddingInserter ogdf::VariableEmbeddingInserter2 ogdf::EmbedderMaxFace ogdf::EmbedderMaxFaceLayers ogdf::EmbedderMinDepth ogdf::EmbedderMinDepthMaxFace ogdf::EmbedderMinDepthMaxFaceLayers ogdf::EmbedderMinDepthPiTa ogdf::SimpleEmbedder ogdf::FastPlanarSubgraph ogdf::MaximalPlanarSubgraphSimple ogdf::MaximumPlanarSubgraph

List of all members.

Public Member Functions

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

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


Constructor & Destructor Documentation

ogdf::Timeouter::Timeouter (  )  [inline]

timeout is turned of by default

Definition at line 75 of file Timeouter.h.

ogdf::Timeouter::Timeouter ( double  t  )  [inline]

timeout is set to the given value (seconds)

Definition at line 78 of file Timeouter.h.

ogdf::Timeouter::Timeouter ( bool  t  )  [inline]

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

Definition at line 81 of file Timeouter.h.

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

Definition at line 83 of file Timeouter.h.

ogdf::Timeouter::~Timeouter (  )  [inline]

Definition at line 85 of file Timeouter.h.


Member Function Documentation

bool ogdf::Timeouter::isTimeLimit (  )  const [inline]

returns whether any time limit is set or not

Definition at line 104 of file Timeouter.h.

void ogdf::Timeouter::timeLimit ( bool  t  )  [inline]

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

Definition at line 94 of file Timeouter.h.

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

returns the current time limit for the call

Definition at line 99 of file Timeouter.h.

void ogdf::Timeouter::timeLimit ( double  t  )  [inline]

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

Definition at line 89 of file Timeouter.h.


Member Data Documentation

double ogdf::Timeouter::m_timeLimit [protected]

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

Definition at line 109 of file Timeouter.h.


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