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 Class Reference

#include <messagenewfftcalculated.h>

+ Inheritance diagram for MessageNewFFTCalculated:
+ Collaboration diagram for MessageNewFFTCalculated:

Public Types

enum  FFTMessageTypes { FFTMessageTypes::NewFFT, FFTMessageTypes::FinalFFT, FFTMessageTypes::Error }
 Type of the FFT Message. More...
 
- Public Types inherited from Message
enum  MessageTypes {
  MSG_CLEAR_RECORDING, MSG_RECORDING_STARTED, MSG_RECORDING_ENDED, MSG_SIGNAL_ANALYSIS_STARTED,
  MSG_SIGNAL_ANALYSIS_ENDED, MSG_FINAL_KEY, MSG_OPTIONS_CHANGED, MSG_CALCULATION_PROGRESS,
  MSG_CHANGE_TUNING_CURVE, MSG_FINAL_KEY_RECOGNIZED, MSG_KEY_DATA_CHANGED, MSG_KEY_SELECTION_CHANGED,
  MSG_MIDI_EVENT, MSG_MODE_CHANGED, MSG_NEW_FFT_CALCULATED, MSG_PRELIMINARY_KEY,
  MSG_PROJECT_FILE, MSG_RECORDER_ENERGY_CHANGED, MSG_STROBOSCOPE_EVENT, MSG_TUNING_DEVIATION
}
 Available message types: More...
 

Public Member Functions

 MessageNewFFTCalculated (FFTAnalyzerErrorTypes errorType)
 
 MessageNewFFTCalculated (FFTMessageTypes type, FFTDataPointer fftdata, std::shared_ptr< FFTPolygon > polygon)
 
virtual ~MessageNewFFTCalculated ()
 
FFTDataPointer getData () const
 
std::shared_ptr< FFTPolygongetPolygon () const
 
FFTMessageTypes getFFTMessageType () const
 
FFTAnalyzerErrorTypes getErrorType () const
 
bool isFinal () const
 
bool hasError () const
 
- Public Member Functions inherited from Message
 Message (MessageTypes type)
 Message constructor. More...
 
virtual ~Message ()
 Virtual destructor without function, can be overwritten in derived classes. More...
 
MessageTypes getType () const
 Get the message type of the message object. More...
 

Private Attributes

const FFTMessageTypes mFFTMessageType
 
FFTDataPointer mFFTData
 
const std::shared_ptr< FFTPolygonmPolygon
 
const FFTAnalyzerErrorTypes mErrorType
 

Detailed Description

Definition at line 28 of file messagenewfftcalculated.h.

Member Enumeration Documentation

Type of the FFT Message.

Enumerator
NewFFT 

A new fft was calculated.

FinalFFT 

The final fft was calculated.

Error 

An error occured during the calculation.

Definition at line 32 of file messagenewfftcalculated.h.

Constructor & Destructor Documentation

MessageNewFFTCalculated::MessageNewFFTCalculated ( FFTAnalyzerErrorTypes  errorType)

Definition at line 22 of file messagenewfftcalculated.cpp.

MessageNewFFTCalculated::MessageNewFFTCalculated ( FFTMessageTypes  type,
FFTDataPointer  fftdata,
std::shared_ptr< FFTPolygon polygon 
)

Definition at line 28 of file messagenewfftcalculated.cpp.

virtual MessageNewFFTCalculated::~MessageNewFFTCalculated ( )
inlinevirtual

Definition at line 50 of file messagenewfftcalculated.h.

Member Function Documentation

FFTDataPointer MessageNewFFTCalculated::getData ( ) const
inline

Definition at line 52 of file messagenewfftcalculated.h.

FFTAnalyzerErrorTypes MessageNewFFTCalculated::getErrorType ( ) const
inline

Definition at line 55 of file messagenewfftcalculated.h.

FFTMessageTypes MessageNewFFTCalculated::getFFTMessageType ( ) const
inline

Definition at line 54 of file messagenewfftcalculated.h.

std::shared_ptr<FFTPolygon> MessageNewFFTCalculated::getPolygon ( ) const
inline

Definition at line 53 of file messagenewfftcalculated.h.

bool MessageNewFFTCalculated::hasError ( ) const
inline

Definition at line 58 of file messagenewfftcalculated.h.

bool MessageNewFFTCalculated::isFinal ( ) const
inline

Definition at line 57 of file messagenewfftcalculated.h.

Member Data Documentation

const FFTAnalyzerErrorTypes MessageNewFFTCalculated::mErrorType
private

Definition at line 43 of file messagenewfftcalculated.h.

FFTDataPointer MessageNewFFTCalculated::mFFTData
private

Definition at line 40 of file messagenewfftcalculated.h.

const FFTMessageTypes MessageNewFFTCalculated::mFFTMessageType
private

Definition at line 39 of file messagenewfftcalculated.h.

const std::shared_ptr<FFTPolygon> MessageNewFFTCalculated::mPolygon
private

Definition at line 41 of file messagenewfftcalculated.h.


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