ff_entrydetailscollection.h

/*
 * File:   ff_entrydetailscollection.h
 * Author: Jari Williamsson
 *
 * Created on den 27 januari 2011, 01:06
 */

#ifndef FF_ENTRYDETAILSCOLLECTION_H
#define FF_ENTRYDETAILSCOLLECTION_H

#include "ff_basecollection.h"


#ifdef PDK_FRAMEWORK_ENTRIES

class FCArticulations : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCArticulation(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCArticulations"; }

    FCArticulations(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    bool ContainsDefID(twobyte articulationID);

    FCArticulation* GetItemAt(int index) { return (FCArticulation*) __FCCollectionEntryDetail::GetItemAt(index); }
};

class FCStemMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCStemMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCStemMods"; }
};

class FCSecondaryBeamBreakMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCSecondaryBeamBreakMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCSecondaryBeamBreakMods"; }
};

class FCCustomStemMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCCustomStemMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCCustomStemMods"; }
};

class FCBrokenBeamMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCBrokenBeamMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCBrokenBeamMods"; }
};


class FCPrimaryBeamMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCBeamMod(false); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCPrimaryBeamMods"; }

    FCPrimaryBeamMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry)
    {        
    }

    FCBeamMod* GetItemAt(int index) { return (FCBeamMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};


class FCSecondaryBeamMods : public __FCCollectionEntryDetail
{
    bool _upstems;
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCBeamMod(true); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCSecondaryBeamMods"; }

    FCSecondaryBeamMods(FCNoteEntry* pConnectEntry) :
                        __FCCollectionEntryDetail()
    {
        _upstems = pConnectEntry->CalcStemUp();
        SetCustomTag(_upstems ? ed_BeamAboveModsSecondary : ed_BeamBelowModsSecondary);
        _pNoteEntry = pConnectEntry;
    }

    bool IsUpStem() { return _upstems; }


    FCBeamMod* GetOrCreateBeam(int beamno)
    {
        if (beamno < 2) return NULL;
        if (beamno > 15) return NULL;
        if (!_pNoteEntry)
        {
#ifdef PDK_FRAMEWORK_DIAGNOSE
            DebugOut("No attached entry on FCSecondaryBeamMods::GetOrCreateBeam() call.");
#endif
            return NULL;

        }
        for (int i = 0; i < GetCount(); i++)
        {
            FCBeamMod* pBeamMod = (FCBeamMod*) GetItemAt(i);
            if (pBeamMod->GetBeamNumber() == beamno) return pBeamMod;
        }
        
        FCBeamMod* pNewBeamMod = new FCBeamMod(true);        
        pNewBeamMod->SetNoteEntry(_pNoteEntry);        
        pNewBeamMod->SetBeamNumber(beamno);        
        pNewBeamMod->SaveNew();        
        Add(pNewBeamMod);
        return pNewBeamMod;
    }

    FCBeamMod* GetBeam(int beamno)
    {
        for (int i = 0; i < GetCount(); i++)
        {
            FCBeamMod* pBeamMod = (FCBeamMod*) GetItemAt(i);
            if (pBeamMod->GetBeamNumber() == beamno) return pBeamMod;
        }
        return NULL;
    }

    bool AllBeamsDataExists()
    {
        if (!_pNoteEntry) return false;

        int beamcount = _pNoteEntry->CalcBeamCount();
        for (int beamno = 2; beamno <= beamcount; beamno++)
        {
            bool found = false;
            for (int i = 0; i < GetCount(); i++)
            {
               FCBeamMod* pBeamMod = (FCBeamMod*) GetItemAt(i);
               if (pBeamMod->GetBeamNumber() == beamno) found = true;
            }
            if (!found) return false;
        }
        return true;
    }

};

class FCTuplets : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCTuplet(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCTuplets"; }

    FCTuplets(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCTuplet* GetItemAt(int index) { return (FCTuplet*) __FCCollectionEntryDetail::GetItemAt(index); }
};

#if (FXT_VERSION > FINALEVERSION_2012) || (DOXYGEN_SHOULD_SKIP_THIS)
/* Check for DOXYGEN_SHOULD_SKIP_THIS as well, so Doxygen parse these classes. */


class FCVerseSyllables : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    virtual __FCBaseData* CreateElement() { return new FCVerseSyllable(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCVerseSyllables"; }
    
    FCVerseSyllables(FCNoteEntry* pConnectEntry = NULL) :
                __FCCollectionEntryDetail(pConnectEntry) {}
    
    FCVerseSyllable* GetItemAt(int index) { return (FCVerseSyllable*) __FCCollectionEntryDetail::GetItemAt(index); }
};


class FCChorusSyllables : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    virtual __FCBaseData* CreateElement() { return new FCChorusSyllable(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCChorusSyllables"; }
    
    FCChorusSyllables(FCNoteEntry* pConnectEntry = NULL) :
    __FCCollectionEntryDetail(pConnectEntry) {}
    
    FCChorusSyllable* GetItemAt(int index) { return (FCChorusSyllable*) __FCCollectionEntryDetail::GetItemAt(index); }
};

class FCSectionSyllables : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    virtual __FCBaseData* CreateElement() { return new FCSectionSyllable(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCSectionSyllables"; }
    
    FCSectionSyllables(FCNoteEntry* pConnectEntry = NULL) :  __FCCollectionEntryDetail(pConnectEntry) {}
    
    FCSectionSyllable* GetItemAt(int index) { return (FCSectionSyllable*) __FCCollectionEntryDetail::GetItemAt(index); }
};

#endif

class FCNoteheadMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCNoteheadMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCNoteheadMods"; }

    FCNoteheadMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCNoteheadMod* GetItemAt(int index) { return (FCNoteheadMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};

class FCAccidentalMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCAccidentalMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCAccidentalMods"; }

    FCAccidentalMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCAccidentalMod* GetItemAt(int index) { return (FCAccidentalMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};

class FCPercussionNoteMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCPercussionNoteMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCPercussionNoteMods"; }

    FCPercussionNoteMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCPercussionNoteMod* GetItemAt(int index) { return (FCPercussionNoteMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};



class FCTablatureNoteMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCTablatureNoteMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCTablatureNoteMods"; }

    FCTablatureNoteMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCTablatureNoteMod* GetItemAt(int index) { return (FCTablatureNoteMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};


class FCStartTieMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCTieMod(true); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCTieMods"; }

    FCStartTieMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
};

class FCEndTieMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCTieMod(false); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCEndTieMods"; }

    FCEndTieMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
};


class FCDotMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCDotMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCDotMods"; }

    FCDotMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCDotMod* GetItemAt(int index) { return (FCDotMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};




class FCCrossStaffMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCCrossStaffMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCCrossStaffMods"; }

    FCCrossStaffMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCCrossStaffMod* GetItemAt(int index) { return (FCCrossStaffMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};

class FCPerformanceMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        virtual __FCBaseData* CreateElement() { return new FCPerformanceMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    virtual const char* ClassName() { return "FCPerformanceMods"; }

    FCPerformanceMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}

    FCPerformanceMod* GetItemAt(int index) { return (FCPerformanceMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};

#endif // #ifdef PDK_FRAMEWORK_ENTRIES

#endif  /* FF_ENTRYDETAILSCOLLECTION_H */