Open
Graph Drawing
Framework

  v.2010.10
 
Overview Class Hierarchy Class Index Class List Members Namespaces Source Files

Public Types | Public Member Functions | Static Public Member Functions

ogdf::Module Class Reference

Base class for modules. More...

#include <ogdf/basic/Module.h>

Inheritance diagram for ogdf::Module:
ogdf::CPlanarSubgraphModule ogdf::CrossingMinimizationModule ogdf::EdgeInsertionModule ogdf::EmbedderModule ogdf::FeasibleUpwardPlanarSubgraph ogdf::FixedUpwardEmbeddingInserter ogdf::FUPSModule ogdf::MMCrossingMinimizationModule ogdf::MMEdgeInsertionModule ogdf::PlanarSubgraphModule ogdf::UpwardEdgeInserterModule ogdf::UpwardPlanarizerModule

List of all members.

Public Types

enum  ReturnType {
  retFeasible, retOptimal, retNoFeasibleSolution, retTimeoutFeasible,
  retTimeoutInfeasible, retError
}
 

The return type of a module.

More...

Public Member Functions

 Module ()
 Initializes a module.
virtual ~Module ()

Static Public Member Functions

static bool isSolution (ReturnType ret)
 Returns true iff retVal indicates that the module returned a feasible solution.

Detailed Description

Base class for modules.

A module represents an algorithm that implements a certain interface. There are various specific module types present in the OGDF, which all inherit Module as a base class. These module types define the interface implemented by the module.

See also:
ModuleOption

Definition at line 76 of file Module.h.

Member Enumeration Documentation

enum ogdf::Module::ReturnType

The return type of a module.

Enumerator:
retFeasible 

The solution is feasible.

retOptimal 

The solution is optimal.

retNoFeasibleSolution 

There exists no feasible solution.

retTimeoutFeasible 

The solution is feasible, but there was a timeout.

retTimeoutInfeasible 

The solution is not feasible due to a timeout.

retError 

Computation was aborted due to an error.

Definition at line 80 of file Module.h.

Constructor & Destructor Documentation

ogdf::Module::Module (  )  [inline]

Initializes a module.

Definition at line 90 of file Module.h.

virtual ogdf::Module::~Module (  )  [inline, virtual]

Definition at line 92 of file Module.h.

Member Function Documentation

static bool ogdf::Module::isSolution ( ReturnType  ret  )  [inline, static]

Returns true iff retVal indicates that the module returned a feasible solution.

Definition at line 95 of file Module.h.

The documentation for this class was generated from the following file:
© 1999-2010 by oreas GmbH, © 2005-2010 by Technische Universität Dortmund, University of Jena and University of Cologne.

Generated on Wed Oct 20 2010 11:14:14 by doxygen 1.7.1.