Entropy Piano Tuner  1.1.3 (documentation not yet complete)
An open-source experimental software for piano tuning by entropy minimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
CalculationAdapter Class Reference

Adapter for starting and stopping the calculation process. More...

#include <calculationadapter.h>

+ Inheritance diagram for CalculationAdapter:
+ Collaboration diagram for CalculationAdapter:

Public Member Functions

 CalculationAdapter (Core *core)
 Constructor, copies a pointer pointing to the core. More...
 
virtual ~CalculationAdapter ()
 Empty virtual destructor. More...
 
virtual void startCalculation (const std::string &algorithmName)
 Function called by the GUI to start the calculation of the tuning curve. More...
 
virtual void cancelCalculation ()
 Function called by the GUI to interrupt or stop the calculation thread. More...
 
std::vector< std::string > getAvailableAlgorithms () const
 Get a list of available tuning algorithms. More...
 

Private Attributes

CoremCore
 Private pointer to the core. More...
 

Detailed Description

Adapter for starting and stopping the calculation process.

This adapter is part of the interface between the core and the GUI. It allows the GUI to start and to interrupt (stop) the calculation process. The adapter is reimplemented in Qt as CalculationProgressGroup.

See also
CalculationProgressGroup

The adapter calls several functions of the Singleton-Calculationmanager.

See also
CalculationManager

Definition at line 46 of file calculationadapter.h.

Constructor & Destructor Documentation

CalculationAdapter::CalculationAdapter ( Core core)

Constructor, copies a pointer pointing to the core.

Parameters
core: Pointer to the instance of the core.

Definition at line 38 of file calculationadapter.cpp.

virtual CalculationAdapter::~CalculationAdapter ( )
inlinevirtual

Empty virtual destructor.

Definition at line 50 of file calculationadapter.h.

Member Function Documentation

void CalculationAdapter::cancelCalculation ( )
virtual

Function called by the GUI to interrupt or stop the calculation thread.

Definition at line 72 of file calculationadapter.cpp.

+ Here is the call graph for this function:

std::vector< std::string > CalculationAdapter::getAvailableAlgorithms ( ) const

Get a list of available tuning algorithms.

Returns
Vector of strings with the names of the algorithms

Definition at line 87 of file calculationadapter.cpp.

+ Here is the call graph for this function:

void CalculationAdapter::startCalculation ( const std::string &  algorithmName)
virtual

Function called by the GUI to start the calculation of the tuning curve.

Definition at line 53 of file calculationadapter.cpp.

+ Here is the call graph for this function:

Member Data Documentation

Core* CalculationAdapter::mCore
private

Private pointer to the core.

Definition at line 58 of file calculationadapter.h.


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