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
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AlgorithmFactoryBase Class Referenceabstract

The AlgorithmFactoryBase class create the desired Algorithm. More...

#include <algorithmfactory.h>

+ Inheritance diagram for AlgorithmFactoryBase:
+ Collaboration diagram for AlgorithmFactoryBase:

Public Member Functions

virtual std::unique_ptr
< Algorithm > 		createAlgorithm (const Piano &piano)=0
 
AlgorithmFactoryDescription & getDescription ()
 

Protected Member Functions

 AlgorithmFactoryBase (const AlgorithmFactoryDescription &description)
 
void loadDefaultParams ()
 

Protected Attributes

AlgorithmFactoryDescription mDescription
 

Detailed Description

The AlgorithmFactoryBase class create the desired Algorithm.

It provides a pure virtual fuction for creating an Algorithm. Also it stores the name of the Algorithm

Definition at line 38 of file algorithmfactory.h.

Constructor & Destructor Documentation

AlgorithmFactoryBase::AlgorithmFactoryBase ( const AlgorithmFactoryDescription &  description)
protected

Definition at line 25 of file algorithmfactory.cpp.

+ Here is the call graph for this function:

Member Function Documentation

virtual std::unique_ptr<Algorithm> AlgorithmFactoryBase::createAlgorithm ( const Piano &  piano)
pure virtual

Implemented in AlgorithmFactory< AlgorithmClass >.

AlgorithmFactoryDescription& AlgorithmFactoryBase::getDescription ( )
inline

Definition at line 46 of file algorithmfactory.h.

void AlgorithmFactoryBase::loadDefaultParams ( )
protected

Definition at line 31 of file algorithmfactory.cpp.

+ Here is the call graph for this function:

Member Data Documentation

AlgorithmFactoryDescription AlgorithmFactoryBase::mDescription
protected

Definition at line 52 of file algorithmfactory.h.

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