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

//=============================================================================
//                                Piano class
//=============================================================================

#ifndef PIANO_H
#define PIANO_H

#include <string>
#include <fstream>

#include "keyboard.h"
#include "pianodefines.h"



class Piano
{
public:
    static const int DEFAULT_NUMBER_OF_KEYS;
    static const int DEFAULT_KEY_NUMBER_OF_A;
    static const int DEFAULT_KEYS_ON_BASS_BRIDGE;
    static const double DEFAULT_CONCERT_PITCH;    

public:
    Piano();
    ~Piano() {};

    using Keys = std::vector<Key>;

    // access functions

    void setName(const std::string &name) {mName = name;}
    const std::string &getName() const {return mName;}

    void setType(piano::PianoType type) {mType = type;}
    piano::PianoType getPianoType() const {return mType;}
    piano::PianoType &getPianoType() {return mType;}

    void setSerialNumber(const std::string &number) {mSerialNumber = number;}
    const std::string &getSerialNumber() const {return mSerialNumber;}

    void setManufactureYear(const std::string &year) {mManufactureYear = year;}
    const std::string &getManufactionYear() const {return mManufactureYear;}

    void setManufactureLocation(const std::string &loc) {mManufactureLocation = loc;}
    const std::string &getManufactionLocation() const {return mManufactureLocation;}

    void setTuningLocation(const std::string &loc) {mTuningLocation = loc;}
    const std::string &getTuningLocation() const {return mTuningLocation;}

    void setTuningTime(const std::string &time) {mTuningTime = time;}
    void setTuningTimeToActualTime();
    const std::string &getTuningTime() const {return mTuningTime;}

    void setConcertPitch(double pitch) {mConcertPitch = pitch;}
    const double &getConcertPitch() const {return mConcertPitch;}
    double &getConcertPitch() {return mConcertPitch;}

    const Keyboard &getKeyboard() const {return mKeyboard;}
    Keyboard &getKeyboard() {return mKeyboard;}

    const Key &getKey(int i) const {return mKeyboard[i];}
    Key &getKey(int i) {return mKeyboard[i];}
    const Key*getKeyPtr(int i) const {if (i < 0) return nullptr; else return &(mKeyboard[i]);}
    Key *getKeyPtr(int i) {if (i<0) return nullptr; else return &(mKeyboard[i]);}

    void setKey (int i, const Key &key) { mKeyboard[i] = key; }

    // other:

    double getExpectedInharmonicity (double f) const;

    double getEqualTempFrequency (int keynumber, double cents=0, double A4=0) const;

    double getDefiningTempFrequency (int keynumber, double cents=0, double A4=0) const;


private:
    std::string mName;
    piano::PianoType mType;
    std::string mSerialNumber;
    std::string mManufactureYear;
    std::string mManufactureLocation;

    std::string mTuningLocation;
    std::string mTuningTime;
    double mConcertPitch;

    Keyboard mKeyboard;

};

#endif // PIANO_H