/media/hdb5/canorusNightlyBuildSystem/trunk/src/core/functionmarking.h

Go to the documentation of this file.

#ifndef FUNCTIONMARKING_H_
#define FUNCTIONMARKING_H_

#include <QList>
#include <QString>

#include "core/muselement.h"

class CAFunctionMarkingContext;

class CAFunctionMarking : public CAMusElement {
public:
        enum CAFunctionType {
                Undefined=0,// no degree - extend the previous one
                I=1,            // 1st
                II=2,           // 2nd
                III=3,          // 3rd
                IV=4,           // 4th
                V=5,            // 5th
                VI=6,           // 6th
                VII=7,          // 7th
                T=8,            // Tonic
                S=9,            // Subdominant
                D=10,           // Dominant
                F=11,           // Phrygian (F for Frigio in Italian)
                N=12,           // Napolitan
                L=13,           // Lidian
                K=14            // Cadenze chord (see http://en.wikipedia.org/wiki/Cadence_%28music%29)
        };
        
        // addedDegrees and alteredDegrees are generated from alterations parameter
        CAFunctionMarking(CAFunctionType function, bool minor, const QString key, CAFunctionMarkingContext* context, int timeStart, int timeLength, CAFunctionType chordArea=Undefined, bool chordAreaMinor=false, CAFunctionType tonicDegree=T, bool tonicDegreeMinor=false, const QString alterations="", bool ellipseSequence=false);
        CAFunctionMarking* clone();
        void clear(); // same as in CASyllable
        ~CAFunctionMarking();
        
        CAFunctionType function() { return _function; }
        QString key() { return _key; }
        CAFunctionType chordArea() { return _chordArea; }
        CAFunctionType tonicDegree() { return _tonicDegree; }
        QList<int> alteredDegrees() { return _alteredDegrees; }
        QList<int> addedDegrees() { return _addedDegrees; }
        void setFunction(CAFunctionType function) { _function = function; }
        void setKey(QString key) { _key = key; }
        void setChordArea(CAFunctionType chordArea) { _chordArea = chordArea; }
        void setChordAreaMinor(bool minor) { _chordAreaMinor = minor; }
        void setTonicDegree(CAFunctionType tonicDegree) { _tonicDegree = tonicDegree; }
        void setTonicDegreeMinor(bool minor) { _tonicDegreeMinor = minor; }
        void setAlteredDegrees(QList<int> degrees) { _alteredDegrees = degrees; }
        void setAddedDegrees(QList<int> degrees) { _addedDegrees = degrees; }
        void setMinor(bool minor) { _minor = minor; }
        void setEllipse(bool ellipse) { _ellipseSequence = ellipse; }
        void setAlterations(const QString alterations);
        
        inline bool isEmpty() { return (function()==Undefined && chordArea()==Undefined && tonicDegree()==T && !alteredDegrees().size() && !addedDegrees().size()); }
        bool isSideDegree();
        
        bool isMinor() { return _minor; }
        bool isChordAreaMinor() { return _chordAreaMinor; }
        bool isTonicDegreeMinor() { return _tonicDegreeMinor; }
        bool isPartOfEllipse() { return _ellipseSequence; }
        
        int compare(CAMusElement *function);
        
        static const QString functionTypeToString(CAFunctionType);
        static CAFunctionType functionTypeFromString(const QString);
        
private:
        CAFunctionType _function;               
        QString _key;                                   
        CAFunctionType _chordArea;              
        bool _chordAreaMinor;                   
        CAFunctionType _tonicDegree;    
        bool _tonicDegreeMinor;                 
        QList<int> _alteredDegrees;             
        QList<int> _addedDegrees;               
        bool _minor;                                    
        bool _ellipseSequence;                  
};
#endif /* FUNCTIONMARKING_H_*/

---