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
messagenewfftcalculated.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Copyright 2015 Haye Hinrichsen, Christoph Wick
3  *
4  * This file is part of Entropy Piano Tuner.
5  *
6  * Entropy Piano Tuner is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by the
8  * Free Software Foundation, either version 3 of the License, or (at your
9  * option) any later version.
10  *
11  * Entropy Piano Tuner is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * Entropy Piano Tuner. If not, see http://www.gnu.org/licenses/.
18  *****************************************************************************/
19 
20 #ifndef MESSAGENEWFFTCALCULATED_H
21 #define MESSAGENEWFFTCALCULATED_H
22 
23 #include "message.h"
24 #include "../analyzers/fftanalyzererrorcodes.h"
25 #include "../math/fftadapter.h"
26 #include "../system/prerequisites.h"
27 
29 {
30 public:
32  enum class FFTMessageTypes {
33  NewFFT,
34  FinalFFT,
35  Error,
36  };
37 
38 private:
41  const std::shared_ptr<FFTPolygon> mPolygon;
42 
44 
45 public:
48  FFTDataPointer fftdata,
49  std::shared_ptr<FFTPolygon> polygon);
51 
52  FFTDataPointer getData() const { return mFFTData; }
53  std::shared_ptr<FFTPolygon> getPolygon() const { return mPolygon; }
56 
57  bool isFinal() const { return mFFTMessageType == FFTMessageTypes::FinalFFT; }
58  bool hasError() const { return mFFTMessageType == FFTMessageTypes::Error; }
59 };
60 
61 #endif // MESSAGENEWFFTCALCULATED_H
An error occured during the calculation.
FFTMessageTypes
Type of the FFT Message.
const std::shared_ptr< FFTPolygon > mPolygon
FFTAnalyzerErrorTypes
Enumeration of possible errors during the fft analysis.
std::shared_ptr< FFTPolygon > getPolygon() const
MessageNewFFTCalculated(FFTAnalyzerErrorTypes errorType)
const FFTAnalyzerErrorTypes mErrorType
FFTDataPointer getData() const
FFTMessageTypes getFFTMessageType() const
The Message class.
Definition: message.h:43
FFTAnalyzerErrorTypes getErrorType() const
std::shared_ptr< FFTData > FFTDataPointer
Shared pointer of FFTData.
Definition: fftadapter.h:86
const FFTMessageTypes mFFTMessageType