examplealgorithm.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright 2015 Haye Hinrichsen, Christoph Wick
 *
 * This file is part of Entropy Piano Tuner.
 *
 * Entropy Piano Tuner is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * Entropy Piano Tuner is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * Entropy Piano Tuner. If not, see http://www.gnu.org/licenses/.
 *****************************************************************************/

//=============================================================================
//     Trivial algorithm for explaining how new algorithms can be built
//=============================================================================

#ifndef EXAMPLEALGORITHM_H
#define EXAMPLEALGORITHM_H

#include "core/calculation/algorithm.h"

// each algorithm has to be in its own namespace to prevent naming conflits
namespace examplealgorithm
{


class ExampleAlgorithm : public Algorithm
{
public:
    // constructor to copy the original piano
    ExampleAlgorithm(const Piano &piano, const AlgorithmFactoryDescription &description);

protected:
    // the implementation of the worker function (sole required function)
    virtual void algorithmWorkerFunction() override final;

private:
    const double mConcertPitchParam;
};

}  // namespace examplealgorithm


#endif // EXAMPLEALGORITHM_H