message.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/.
 *****************************************************************************/

//======================================================================
//                      Class for a single message
//======================================================================

#ifndef MESSAGE_H
#define MESSAGE_H

#include <memory>


class Message
{
public:
    enum MessageTypes
    {
        // Bare messages without appended data
        MSG_CLEAR_RECORDING,                    
        MSG_RECORDING_STARTED,                  
        MSG_RECORDING_ENDED,                    
        MSG_SIGNAL_ANALYSIS_STARTED,            
        MSG_SIGNAL_ANALYSIS_ENDED,              
        MSG_FINAL_KEY,                          
        MSG_OPTIONS_CHANGED,                    

        // Complex messages carrying data in associated message classes:
        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,                   
    };

public:

    explicit Message(MessageTypes type);

    virtual ~Message();

    MessageTypes getType() const {return mType;}

private:
    const MessageTypes mType;
};


typedef std::shared_ptr<Message> MessagePtr;    

#endif // MESSAGE_H