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

#include <messagecaluclationprogress.h>

+ Inheritance diagram for MessageCaluclationProgress:
+ Collaboration diagram for MessageCaluclationProgress:

Public Types

enum  MessageCalculationProgressTypes {
  CALCULATION_FAILED, CALCULATION_STARTED, CALCULATION_ENDED, CALCULATION_PROGRESSED,
  CALCULATION_ENTROPY_REDUCTION_STARTED
}
 
enum  MessageCalculationError {
  CALCULATION_ERROR_NONE, CALCULATION_ERROR_NO_DATA, CALCULATION_ERROR_NOT_ALL_KEYS_RECORDED, CALCULATION_ERROR_KEY_DATA_INCONSISTENT,
  CALCULATION_ERROR_NO_DATA_LEFTSECTION, CALCULATION_ERROR_NO_DATA_RIGHTSECTION
}
 
- 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

 MessageCaluclationProgress (MessageCalculationProgressTypes type, double value=0)
 
 MessageCaluclationProgress (MessageCalculationProgressTypes type, MessageCalculationError errorcode)
 
 ~MessageCaluclationProgress ()
 
double getValue () const
 
MessageCalculationProgressTypes getCalculationType () const
 
MessageCalculationError getErrorCode () 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
MessageCalculationProgressTypes 
mCalculationType
 
const double mValue
 
const MessageCalculationError mErrorCode
 

Detailed Description

Definition at line 25 of file messagecaluclationprogress.h.

Member Enumeration Documentation

Enumerator
CALCULATION_ERROR_NONE 
CALCULATION_ERROR_NO_DATA 
CALCULATION_ERROR_NOT_ALL_KEYS_RECORDED 
CALCULATION_ERROR_KEY_DATA_INCONSISTENT 
CALCULATION_ERROR_NO_DATA_LEFTSECTION 
CALCULATION_ERROR_NO_DATA_RIGHTSECTION 

Definition at line 37 of file messagecaluclationprogress.h.

Enumerator
CALCULATION_FAILED 
CALCULATION_STARTED 
CALCULATION_ENDED 
CALCULATION_PROGRESSED 
CALCULATION_ENTROPY_REDUCTION_STARTED 

Definition at line 28 of file messagecaluclationprogress.h.

Constructor & Destructor Documentation

MessageCaluclationProgress::MessageCaluclationProgress ( MessageCalculationProgressTypes  type,
double  value = 0 
)

Definition at line 22 of file messagecaluclationprogress.cpp.

MessageCaluclationProgress::MessageCaluclationProgress ( MessageCalculationProgressTypes  type,
MessageCalculationError  errorcode 
)

Definition at line 30 of file messagecaluclationprogress.cpp.

MessageCaluclationProgress::~MessageCaluclationProgress ( )

Definition at line 39 of file messagecaluclationprogress.cpp.

Member Function Documentation

MessageCalculationProgressTypes MessageCaluclationProgress::getCalculationType ( ) const
inline

Definition at line 53 of file messagecaluclationprogress.h.

MessageCalculationError MessageCaluclationProgress::getErrorCode ( ) const
inline

Definition at line 54 of file messagecaluclationprogress.h.

double MessageCaluclationProgress::getValue ( ) const
inline

Definition at line 52 of file messagecaluclationprogress.h.

Member Data Documentation

const MessageCalculationProgressTypes MessageCaluclationProgress::mCalculationType
private

Definition at line 57 of file messagecaluclationprogress.h.

const MessageCalculationError MessageCaluclationProgress::mErrorCode
private

Definition at line 59 of file messagecaluclationprogress.h.

const double MessageCaluclationProgress::mValue
private

Definition at line 58 of file messagecaluclationprogress.h.


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