ogdf::Module Class Reference

Base class for modules. More...

#include <ogdf/basic/Module.h>

Inheritance diagram for ogdf::Module:

Public Types
enum	ReturnType { ReturnType::Feasible, ReturnType::Optimal, ReturnType::NoFeasibleSolution, ReturnType::TimeoutFeasible, ReturnType::TimeoutInfeasible, ReturnType::Error }
	The return type of a module. More...

Public Member Functions
	Module ()
	Initializes a module. More...
virtual	~Module ()

Static Public Member Functions
static bool	isSolution (ReturnType ret)
	Returns true iff ret indicates that the module returned a feasible solution. More...

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.

Definition at line 49 of file Module.h.

Member Enumeration Documentation

ReturnType

enum ogdf::Module::ReturnType

strong

The return type of a module.

Enumerator
Feasible	The solution is feasible.
Optimal	The solution is optimal.
NoFeasibleSolution	There exists no feasible solution.
TimeoutFeasible	The solution is feasible, but there was a timeout.
TimeoutInfeasible	The solution is not feasible due to a timeout.
Error	Computation was aborted due to an error.

Definition at line 52 of file Module.h.

Constructor & Destructor Documentation

Module()

ogdf::Module::Module ( )

inline

Initializes a module.

Definition at line 62 of file Module.h.

~Module()

virtual ogdf::Module::~Module ( )

inlinevirtual

Definition at line 64 of file Module.h.

Member Function Documentation

isSolution()

static bool ogdf::Module::isSolution ( ReturnType  ret )

inlinestatic

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

Definition at line 67 of file Module.h.

---

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

• include/ogdf/basic/Module.h