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
        __FCBaseData* CreateElement() override { return new FCArticulation(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCArticulations"; }
 
    FCArticulations(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    bool ContainsDefID(twobyte articulationID);
 
    FCArticulation* GetItemAt(int index) const { return (FCArticulation*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCStemMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCStemMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCStemMods"; }
};
 
class FCSecondaryBeamBreakMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCSecondaryBeamBreakMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCSecondaryBeamBreakMods"; }
};
 
class FCCustomStemMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCCustomStemMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCCustomStemMods"; }
};
 
class FCBrokenBeamMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCBrokenBeamMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCBrokenBeamMods"; }
};
 
 
class FCPrimaryBeamMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCBeamMod(false); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCPrimaryBeamMods"; }
 
    FCPrimaryBeamMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry)
    {        
    }
 
    FCBeamMod* GetItemAt(int index) const { return (FCBeamMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
 
class FCSecondaryBeamMods : public __FCCollectionEntryDetail
{
    bool _upstems;
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCBeamMod(true); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCSecondaryBeamMods"; }
 
    FCSecondaryBeamMods(FCNoteEntry* pConnectEntry) :
                        __FCCollectionEntryDetail()
    {
        UseUpStemData(pConnectEntry->CalcStemUp());
        _pNoteEntry = pConnectEntry;
    }
    
    void UseUpStemData(bool useupstem)
    {
        _upstems = useupstem;
        SetCustomTag(_upstems ? ed_BeamAboveModsSecondary : ed_BeamBelowModsSecondary);
    }
 
    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;
 
        const int beamcount = _pNoteEntry->CalcBeamCount();
        for (int beamno = 2; beamno <= beamcount; beamno++)
            if (! GetBeam(beamno)) return false;
        return true;
    }
 
    bool AssureAllBeamsDataExists()
    {
        if (!_pNoteEntry) return false;
 
        const int beamcount = _pNoteEntry->CalcBeamCount();
        for (int beamno = 2; beamno <= beamcount; beamno++)
            if (! GetOrCreateBeam(beamno)) return false;
        return true;
    }
 
    FCBeamMod* GetItemAt(int index) const { return (FCBeamMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCTuplets : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCTuplet(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCTuplets"; }
 
    FCTuplets(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCTuplet* GetItemAt(int index) const { 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
    __FCBaseData* CreateElement() override { return new FCVerseSyllable(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCVerseSyllables"; }
    
    FCVerseSyllables(FCNoteEntry* pConnectEntry = NULL) :
                __FCCollectionEntryDetail(pConnectEntry) {}
    
    FCVerseSyllable* GetItemAt(int index) const { return (FCVerseSyllable*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
 
class FCChorusSyllables : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    __FCBaseData* CreateElement() override { return new FCChorusSyllable(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCChorusSyllables"; }
    
    FCChorusSyllables(FCNoteEntry* pConnectEntry = NULL) :
    __FCCollectionEntryDetail(pConnectEntry) {}
    
    FCChorusSyllable* GetItemAt(int index) const { return (FCChorusSyllable*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCSectionSyllables : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    __FCBaseData* CreateElement() override { return new FCSectionSyllable(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCSectionSyllables"; }
    
    FCSectionSyllables(FCNoteEntry* pConnectEntry = NULL) :  __FCCollectionEntryDetail(pConnectEntry) {}
    
    FCSectionSyllable* GetItemAt(int index) const { return (FCSectionSyllable*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
#endif
 
class FCNoteheadMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCNoteheadMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCNoteheadMods"; }
 
    FCNoteheadMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCNoteheadMod* GetItemAt(int index) const { return (FCNoteheadMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCAccidentalMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCAccidentalMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCAccidentalMods"; }
 
    FCAccidentalMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCAccidentalMod* GetItemAt(int index) const { return (FCAccidentalMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCPercussionNoteMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCPercussionNoteMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCPercussionNoteMods"; }
 
    FCPercussionNoteMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCPercussionNoteMod* GetItemAt(int index) const { return (FCPercussionNoteMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
 
 
class FCTablatureNoteMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCTablatureNoteMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCTablatureNoteMods"; }
 
    FCTablatureNoteMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCTablatureNoteMod* GetItemAt(int index) const { return (FCTablatureNoteMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
 
class FCStartTieMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCTieMod(FCTieMod::TIEMODTYPE_TIESTART); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCStartTieMods"; }
 
    FCStartTieMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry)
    {
        SetCustomTag(ed_TieModsStart);
    }
 
    FCTieMod* GetItemAt(int index) const { return (FCTieMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCEndTieMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCTieMod(FCTieMod::TIEMODTYPE_TIEEND); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCEndTieMods"; }
 
    FCEndTieMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry)
    {
        SetCustomTag(ed_TieModsEnd);
    }
 
    FCTieMod* GetItemAt(int index) const { return (FCTieMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
 
class FCDotMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCDotMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCDotMods"; }
 
    FCDotMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCDotMod* GetItemAt(int index) const { return (FCDotMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
 
 
 
class FCCrossStaffMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCCrossStaffMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCCrossStaffMods"; }
 
    FCCrossStaffMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCCrossStaffMod* GetItemAt(int index) const { return (FCCrossStaffMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
class FCPerformanceMods : public __FCCollectionEntryDetail
{
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
        __FCBaseData* CreateElement() override { return new FCPerformanceMod(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
public:
    const char* ClassName() const override { return "FCPerformanceMods"; }
 
    FCPerformanceMods(FCNoteEntry* pConnectEntry = NULL) :
                        __FCCollectionEntryDetail(pConnectEntry) {}
 
    FCPerformanceMod* GetItemAt(int index) const { return (FCPerformanceMod*) __FCCollectionEntryDetail::GetItemAt(index); }
};
 
#endif // #ifdef PDK_FRAMEWORK_ENTRIES
 
#endif  /* FF_ENTRYDETAILSCOLLECTION_H */