Verovio
Source code documentation
vrv::GetRelativeLayerElementFunctor Class Reference

This class goes through all layer elements of the layer and returns the next/previous element (depending on traversal direction) relative to the specified layer element. More...

#include <findlayerelementsfunctor.h>

Inheritance diagram for vrv::GetRelativeLayerElementFunctor:
vrv::ConstFunctor vrv::FunctorBase vrv::ConstFunctorInterface

Public Member Functions

bool ImplementsEndInterface () const override
 Return true if the functor implements the end interface.
 
const LayerElementGetRelativeElement () const
 
Constructors, destructors
 GetRelativeLayerElementFunctor (int elementIndex, bool anotherLayer)
 
virtual ~GetRelativeLayerElementFunctor ()=default
 
FunctorCode VisitLayerElement (const LayerElement *layerElement) override
 
- Public Member Functions inherited from vrv::ConstFunctor
 ConstFunctor ()
 
virtual ~ConstFunctor ()=default
 
- Public Member Functions inherited from vrv::FunctorBase
 FunctorBase ()
 
virtual ~FunctorBase ()=default
 
FunctorCode GetCode () const
 Getter/Setter for the functor code which controls traversal.
 
void ResetCode ()
 
void SetCode (FunctorCode code)
 
bool VisibleOnly () const
 Getter/Setter for the visibility.
 
void SetVisibleOnly (bool visibleOnly)
 
FiltersGetFilters () const
 Getters/Setters for the filters and direction Here setters return the previous value.
 
FiltersSetFilters (Filters *filters)
 
bool GetDirection () const
 
bool SetDirection (bool direction)
 
- Public Member Functions inherited from vrv::ConstFunctorInterface
 ConstFunctorInterface ()
 
virtual ~ConstFunctorInterface ()=default
 
virtual FunctorCode VisitObject (const Object *object)
 
virtual FunctorCode VisitObjectEnd (const Object *object)
 
virtual FunctorCode VisitDoc (const Doc *doc)
 
virtual FunctorCode VisitDocEnd (const Doc *doc)
 
virtual FunctorCode VisitCourse (const Course *course)
 
virtual FunctorCode VisitCourseEnd (const Course *course)
 
virtual FunctorCode VisitGrpSym (const GrpSym *grpSym)
 
virtual FunctorCode VisitGrpSymEnd (const GrpSym *grpSym)
 
virtual FunctorCode VisitInstrDef (const InstrDef *instrDef)
 
virtual FunctorCode VisitInstrDefEnd (const InstrDef *instrDef)
 
virtual FunctorCode VisitLabel (const Label *label)
 
virtual FunctorCode VisitLabelEnd (const Label *label)
 
virtual FunctorCode VisitLabelAbbr (const LabelAbbr *labelAbbr)
 
virtual FunctorCode VisitLabelAbbrEnd (const LabelAbbr *labelAbbr)
 
virtual FunctorCode VisitLayer (const Layer *layer)
 
virtual FunctorCode VisitLayerEnd (const Layer *layer)
 
virtual FunctorCode VisitLayerDef (const LayerDef *layerDef)
 
virtual FunctorCode VisitLayerDefEnd (const LayerDef *layerDef)
 
virtual FunctorCode VisitMeasure (const Measure *measure)
 
virtual FunctorCode VisitMeasureEnd (const Measure *measure)
 
virtual FunctorCode VisitPage (const Page *page)
 
virtual FunctorCode VisitPageEnd (const Page *page)
 
virtual FunctorCode VisitPages (const Pages *pages)
 
virtual FunctorCode VisitPagesEnd (const Pages *pages)
 
virtual FunctorCode VisitPb (const Pb *pb)
 
virtual FunctorCode VisitPbEnd (const Pb *pb)
 
virtual FunctorCode VisitSb (const Sb *sb)
 
virtual FunctorCode VisitSbEnd (const Sb *sb)
 
virtual FunctorCode VisitScoreDef (const ScoreDef *scoreDef)
 
virtual FunctorCode VisitScoreDefEnd (const ScoreDef *scoreDef)
 
virtual FunctorCode VisitScoreDefElement (const ScoreDefElement *scoreDefElement)
 
virtual FunctorCode VisitScoreDefElementEnd (const ScoreDefElement *scoreDefElement)
 
virtual FunctorCode VisitStaff (const Staff *staff)
 
virtual FunctorCode VisitStaffEnd (const Staff *staff)
 
virtual FunctorCode VisitStaffDef (const StaffDef *staffDef)
 
virtual FunctorCode VisitStaffDefEnd (const StaffDef *staffDef)
 
virtual FunctorCode VisitStaffGrp (const StaffGrp *staffGrp)
 
virtual FunctorCode VisitStaffGrpEnd (const StaffGrp *staffGrp)
 
virtual FunctorCode VisitSystem (const System *system)
 
virtual FunctorCode VisitSystemEnd (const System *system)
 
virtual FunctorCode VisitTuning (const Tuning *tuning)
 
virtual FunctorCode VisitTuningEnd (const Tuning *tuning)
 
virtual FunctorCode VisitEditorialElement (const EditorialElement *editorialElement)
 
virtual FunctorCode VisitEditorialElementEnd (const EditorialElement *editorialElement)
 
virtual FunctorCode VisitDiv (const Div *div)
 
virtual FunctorCode VisitDivEnd (const Div *div)
 
virtual FunctorCode VisitRunningElement (const RunningElement *runningElement)
 
virtual FunctorCode VisitRunningElementEnd (const RunningElement *runningElement)
 
virtual FunctorCode VisitPgFoot (const PgFoot *pgFoot)
 
virtual FunctorCode VisitPgFootEnd (const PgFoot *pgFoot)
 
virtual FunctorCode VisitPgHead (const PgHead *pgHead)
 
virtual FunctorCode VisitPgHeadEnd (const PgHead *pgHead)
 
virtual FunctorCode VisitTextLayoutElement (const TextLayoutElement *textLayoutElement)
 
virtual FunctorCode VisitTextLayoutElementEnd (const TextLayoutElement *textLayoutElement)
 
virtual FunctorCode VisitEnding (const Ending *ending)
 
virtual FunctorCode VisitEndingEnd (const Ending *ending)
 
virtual FunctorCode VisitExpansion (const Expansion *expansion)
 
virtual FunctorCode VisitExpansionEnd (const Expansion *expansion)
 
virtual FunctorCode VisitSection (const Section *section)
 
virtual FunctorCode VisitSectionEnd (const Section *section)
 
virtual FunctorCode VisitSystemElement (const SystemElement *systemElement)
 
virtual FunctorCode VisitSystemElementEnd (const SystemElement *systemElement)
 
virtual FunctorCode VisitSystemMilestone (const SystemMilestoneEnd *systemMilestoneEnd)
 
virtual FunctorCode VisitSystemMilestoneEnd (const SystemMilestoneEnd *systemMilestoneEnd)
 
virtual FunctorCode VisitMdiv (const Mdiv *mdiv)
 
virtual FunctorCode VisitMdivEnd (const Mdiv *mdiv)
 
virtual FunctorCode VisitPageElement (const PageElement *pageElement)
 
virtual FunctorCode VisitPageElementEnd (const PageElement *pageElement)
 
virtual FunctorCode VisitPageMilestone (const PageMilestoneEnd *pageMilestoneEnd)
 
virtual FunctorCode VisitPageMilestoneEnd (const PageMilestoneEnd *pageMilestoneEnd)
 
virtual FunctorCode VisitScore (const Score *score)
 
virtual FunctorCode VisitScoreEnd (const Score *score)
 
virtual FunctorCode VisitAnchoredText (const AnchoredText *anchoredText)
 
virtual FunctorCode VisitAnchoredTextEnd (const AnchoredText *anchoredText)
 
virtual FunctorCode VisitArpeg (const Arpeg *arpeg)
 
virtual FunctorCode VisitArpegEnd (const Arpeg *arpeg)
 
virtual FunctorCode VisitBeamSpan (const BeamSpan *beamSpan)
 
virtual FunctorCode VisitBeamSpanEnd (const BeamSpan *beamSpan)
 
virtual FunctorCode VisitBracketSpan (const BracketSpan *bracketSpan)
 
virtual FunctorCode VisitBracketSpanEnd (const BracketSpan *bracketSpan)
 
virtual FunctorCode VisitBreath (const Breath *breath)
 
virtual FunctorCode VisitBreathEnd (const Breath *breath)
 
virtual FunctorCode VisitCaesura (const Caesura *caesura)
 
virtual FunctorCode VisitCaesuraEnd (const Caesura *caesura)
 
virtual FunctorCode VisitControlElement (const ControlElement *controlElement)
 
virtual FunctorCode VisitControlElementEnd (const ControlElement *controlElement)
 
virtual FunctorCode VisitCpMark (const CpMark *cpMark)
 
virtual FunctorCode VisitCpMarkEnd (const CpMark *cpMark)
 
virtual FunctorCode VisitDir (const Dir *dir)
 
virtual FunctorCode VisitDirEnd (const Dir *dir)
 
virtual FunctorCode VisitDynam (const Dynam *dynam)
 
virtual FunctorCode VisitDynamEnd (const Dynam *dynam)
 
virtual FunctorCode VisitFermata (const Fermata *fermata)
 
virtual FunctorCode VisitFermataEnd (const Fermata *fermata)
 
virtual FunctorCode VisitFing (const Fing *fing)
 
virtual FunctorCode VisitFingEnd (const Fing *fing)
 
virtual FunctorCode VisitGliss (const Gliss *gliss)
 
virtual FunctorCode VisitGlissEnd (const Gliss *gliss)
 
virtual FunctorCode VisitHairpin (const Hairpin *hairpin)
 
virtual FunctorCode VisitHairpinEnd (const Hairpin *hairpin)
 
virtual FunctorCode VisitHarm (const Harm *harm)
 
virtual FunctorCode VisitHarmEnd (const Harm *harm)
 
virtual FunctorCode VisitLv (const Lv *lv)
 
virtual FunctorCode VisitLvEnd (const Lv *lv)
 
virtual FunctorCode VisitMordent (const Mordent *mordent)
 
virtual FunctorCode VisitMordentEnd (const Mordent *mordent)
 
virtual FunctorCode VisitOctave (const Octave *octave)
 
virtual FunctorCode VisitOctaveEnd (const Octave *octave)
 
virtual FunctorCode VisitOrnam (const Ornam *ornam)
 
virtual FunctorCode VisitOrnamEnd (const Ornam *ornam)
 
virtual FunctorCode VisitPedal (const Pedal *pedal)
 
virtual FunctorCode VisitPedalEnd (const Pedal *pedal)
 
virtual FunctorCode VisitPhrase (const Phrase *phrase)
 
virtual FunctorCode VisitPhraseEnd (const Phrase *phrase)
 
virtual FunctorCode VisitPitchInflection (const PitchInflection *pitchInflection)
 
virtual FunctorCode VisitPitchInflectionEnd (const PitchInflection *pitchInflection)
 
virtual FunctorCode VisitReh (const Reh *reh)
 
virtual FunctorCode VisitRehEnd (const Reh *reh)
 
virtual FunctorCode VisitRepeatMark (const RepeatMark *repeatMark)
 
virtual FunctorCode VisitRepeatMarkEnd (const RepeatMark *repeatMark)
 
virtual FunctorCode VisitSlur (const Slur *slur)
 
virtual FunctorCode VisitSlurEnd (const Slur *slur)
 
virtual FunctorCode VisitTempo (const Tempo *tempo)
 
virtual FunctorCode VisitTempoEnd (const Tempo *tempo)
 
virtual FunctorCode VisitTie (const Tie *tie)
 
virtual FunctorCode VisitTieEnd (const Tie *tie)
 
virtual FunctorCode VisitTrill (const Trill *trill)
 
virtual FunctorCode VisitTrillEnd (const Trill *trill)
 
virtual FunctorCode VisitTurn (const Turn *turn)
 
virtual FunctorCode VisitTurnEnd (const Turn *turn)
 
virtual FunctorCode VisitAccid (const Accid *accid)
 
virtual FunctorCode VisitAccidEnd (const Accid *accid)
 
virtual FunctorCode VisitArtic (const Artic *artic)
 
virtual FunctorCode VisitArticEnd (const Artic *artic)
 
virtual FunctorCode VisitBarLine (const BarLine *barLine)
 
virtual FunctorCode VisitBarLineEnd (const BarLine *barLine)
 
virtual FunctorCode VisitBeam (const Beam *beam)
 
virtual FunctorCode VisitBeamEnd (const Beam *beam)
 
virtual FunctorCode VisitBeatRpt (const BeatRpt *beatRpt)
 
virtual FunctorCode VisitBeatRptEnd (const BeatRpt *beatRpt)
 
virtual FunctorCode VisitBTrem (const BTrem *bTrem)
 
virtual FunctorCode VisitBTremEnd (const BTrem *bTrem)
 
virtual FunctorCode VisitChord (const Chord *chord)
 
virtual FunctorCode VisitChordEnd (const Chord *chord)
 
virtual FunctorCode VisitClef (const Clef *clef)
 
virtual FunctorCode VisitClefEnd (const Clef *clef)
 
virtual FunctorCode VisitCustos (const Custos *custos)
 
virtual FunctorCode VisitCustosEnd (const Custos *custos)
 
virtual FunctorCode VisitDot (const Dot *dot)
 
virtual FunctorCode VisitDotEnd (const Dot *dot)
 
virtual FunctorCode VisitDots (const Dots *dots)
 
virtual FunctorCode VisitDotsEnd (const Dots *dots)
 
virtual FunctorCode VisitFlag (const Flag *flag)
 
virtual FunctorCode VisitFlagEnd (const Flag *flag)
 
virtual FunctorCode VisitFTrem (const FTrem *fTrem)
 
virtual FunctorCode VisitFTremEnd (const FTrem *fTrem)
 
virtual FunctorCode VisitGenericLayerElement (const GenericLayerElement *genericLayerElement)
 
virtual FunctorCode VisitGenericLayerElementEnd (const GenericLayerElement *genericLayerElement)
 
virtual FunctorCode VisitGraceGrp (const GraceGrp *graceGrp)
 
virtual FunctorCode VisitGraceGrpEnd (const GraceGrp *graceGrp)
 
virtual FunctorCode VisitHalfmRpt (const HalfmRpt *halfmRpt)
 
virtual FunctorCode VisitHalfmRptEnd (const HalfmRpt *halfmRpt)
 
virtual FunctorCode VisitKeyAccid (const KeyAccid *keyAccid)
 
virtual FunctorCode VisitKeyAccidEnd (const KeyAccid *keyAccid)
 
virtual FunctorCode VisitKeySig (const KeySig *keySig)
 
virtual FunctorCode VisitKeySigEnd (const KeySig *keySig)
 
virtual FunctorCode VisitLayerElementEnd (const LayerElement *layerElement)
 
virtual FunctorCode VisitLigature (const Ligature *ligature)
 
virtual FunctorCode VisitLigatureEnd (const Ligature *ligature)
 
virtual FunctorCode VisitMensur (const Mensur *mensur)
 
virtual FunctorCode VisitMensurEnd (const Mensur *mensur)
 
virtual FunctorCode VisitMeterSig (const MeterSig *meterSig)
 
virtual FunctorCode VisitMeterSigEnd (const MeterSig *meterSig)
 
virtual FunctorCode VisitMeterSigGrp (const MeterSigGrp *meterSigGrp)
 
virtual FunctorCode VisitMeterSigGrpEnd (const MeterSigGrp *meterSigGrp)
 
virtual FunctorCode VisitMRest (const MRest *mRest)
 
virtual FunctorCode VisitMRestEnd (const MRest *mRest)
 
virtual FunctorCode VisitMRpt (const MRpt *mRpt)
 
virtual FunctorCode VisitMRptEnd (const MRpt *mRpt)
 
virtual FunctorCode VisitMRpt2 (const MRpt2 *mRpt2)
 
virtual FunctorCode VisitMRpt2End (const MRpt2 *mRpt2)
 
virtual FunctorCode VisitMSpace (const MSpace *mSpace)
 
virtual FunctorCode VisitMSpaceEnd (const MSpace *mSpace)
 
virtual FunctorCode VisitMultiRest (const MultiRest *multiRest)
 
virtual FunctorCode VisitMultiRestEnd (const MultiRest *multiRest)
 
virtual FunctorCode VisitMultiRpt (const MultiRpt *multiRpt)
 
virtual FunctorCode VisitMultiRptEnd (const MultiRpt *multiRpt)
 
virtual FunctorCode VisitNc (const Nc *nc)
 
virtual FunctorCode VisitNcEnd (const Nc *nc)
 
virtual FunctorCode VisitNeume (const Neume *neume)
 
virtual FunctorCode VisitNeumeEnd (const Neume *neume)
 
virtual FunctorCode VisitNote (const Note *note)
 
virtual FunctorCode VisitNoteEnd (const Note *note)
 
virtual FunctorCode VisitPlica (const Plica *plica)
 
virtual FunctorCode VisitPlicaEnd (const Plica *plica)
 
virtual FunctorCode VisitProport (const Proport *proport)
 
virtual FunctorCode VisitProportEnd (const Proport *proport)
 
virtual FunctorCode VisitRest (const Rest *rest)
 
virtual FunctorCode VisitRestEnd (const Rest *rest)
 
virtual FunctorCode VisitSpace (const Space *space)
 
virtual FunctorCode VisitSpaceEnd (const Space *space)
 
virtual FunctorCode VisitStem (const Stem *stem)
 
virtual FunctorCode VisitStemEnd (const Stem *stem)
 
virtual FunctorCode VisitSyl (const Syl *syl)
 
virtual FunctorCode VisitSylEnd (const Syl *syl)
 
virtual FunctorCode VisitSyllable (const Syllable *syllable)
 
virtual FunctorCode VisitSyllableEnd (const Syllable *syllable)
 
virtual FunctorCode VisitTabDurSym (const TabDurSym *tabDurSym)
 
virtual FunctorCode VisitTabDurSymEnd (const TabDurSym *tabDurSym)
 
virtual FunctorCode VisitTabGrp (const TabGrp *tabGrp)
 
virtual FunctorCode VisitTabGrpEnd (const TabGrp *tabGrp)
 
virtual FunctorCode VisitTimestamp (const TimestampAttr *timestamp)
 
virtual FunctorCode VisitTimestampEnd (const TimestampAttr *timestamp)
 
virtual FunctorCode VisitTuplet (const Tuplet *tuplet)
 
virtual FunctorCode VisitTupletEnd (const Tuplet *tuplet)
 
virtual FunctorCode VisitTupletBracket (const TupletBracket *tupletBracket)
 
virtual FunctorCode VisitTupletBracketEnd (const TupletBracket *tupletBracket)
 
virtual FunctorCode VisitTupletNum (const TupletNum *tupletNum)
 
virtual FunctorCode VisitTupletNumEnd (const TupletNum *tupletNum)
 
virtual FunctorCode VisitVerse (const Verse *verse)
 
virtual FunctorCode VisitVerseEnd (const Verse *verse)
 
virtual FunctorCode VisitF (const F *f)
 
virtual FunctorCode VisitFEnd (const F *f)
 
virtual FunctorCode VisitFb (const Fb *fb)
 
virtual FunctorCode VisitFbEnd (const Fb *fb)
 
virtual FunctorCode VisitFig (const Fig *fig)
 
virtual FunctorCode VisitFigEnd (const Fig *fig)
 
virtual FunctorCode VisitLb (const Lb *lb)
 
virtual FunctorCode VisitLbEnd (const Lb *lb)
 
virtual FunctorCode VisitMNum (const MNum *mNum)
 
virtual FunctorCode VisitMNumEnd (const MNum *mNum)
 
virtual FunctorCode VisitNum (const Num *num)
 
virtual FunctorCode VisitNumEnd (const Num *num)
 
virtual FunctorCode VisitRend (const Rend *rend)
 
virtual FunctorCode VisitRendEnd (const Rend *rend)
 
virtual FunctorCode VisitSvg (const Svg *svg)
 
virtual FunctorCode VisitSvgEnd (const Svg *svg)
 
virtual FunctorCode VisitSymbol (const Symbol *symbol)
 
virtual FunctorCode VisitSymbolEnd (const Symbol *symbol)
 
virtual FunctorCode VisitText (const Text *text)
 
virtual FunctorCode VisitTextEnd (const Text *text)
 
virtual FunctorCode VisitTextElement (const TextElement *textElement)
 
virtual FunctorCode VisitTextElementEnd (const TextElement *textElement)
 
virtual FunctorCode VisitFacsimile (const Facsimile *facsimile)
 
virtual FunctorCode VisitFacsimileEnd (const Facsimile *facsimile)
 
virtual FunctorCode VisitGraphic (const Graphic *graphic)
 
virtual FunctorCode VisitGraphicEnd (const Graphic *graphic)
 
virtual FunctorCode VisitSurface (const Surface *surface)
 
virtual FunctorCode VisitSurfaceEnd (const Surface *surface)
 
virtual FunctorCode VisitZone (const Zone *zone)
 
virtual FunctorCode VisitZoneEnd (const Zone *zone)
 
virtual FunctorCode VisitAlignment (const Alignment *alignment)
 
virtual FunctorCode VisitAlignmentEnd (const Alignment *alignment)
 
virtual FunctorCode VisitAlignmentReference (const AlignmentReference *alignmentReference)
 
virtual FunctorCode VisitAlignmentReferenceEnd (const AlignmentReference *alignmentReference)
 
virtual FunctorCode VisitHorizontalAligner (const HorizontalAligner *horizontalAligner)
 
virtual FunctorCode VisitHorizontalAlignerEnd (const HorizontalAligner *horizontalAligner)
 
virtual FunctorCode VisitMeasureAligner (const MeasureAligner *measureAligner)
 
virtual FunctorCode VisitMeasureAlignerEnd (const MeasureAligner *measureAligner)
 
virtual FunctorCode VisitGraceAligner (const GraceAligner *graceAligner)
 
virtual FunctorCode VisitGraceAlignerEnd (const GraceAligner *graceAligner)
 
virtual FunctorCode VisitTimestampAligner (const TimestampAligner *timestampAligner)
 
virtual FunctorCode VisitTimestampAlignerEnd (const TimestampAligner *timestampAligner)
 
virtual FunctorCode VisitSystemAligner (const SystemAligner *systemAligner)
 
virtual FunctorCode VisitSystemAlignerEnd (const SystemAligner *systemAligner)
 
virtual FunctorCode VisitStaffAlignment (const StaffAlignment *staffAlignment)
 
virtual FunctorCode VisitStaffAlignmentEnd (const StaffAlignment *staffAlignment)
 
virtual FunctorCode VisitFloatingObject (const FloatingObject *floatingObject)
 
virtual FunctorCode VisitFloatingObjectEnd (const FloatingObject *floatingObject)
 

Detailed Description

This class goes through all layer elements of the layer and returns the next/previous element (depending on traversal direction) relative to the specified layer element.

It will search recursively through children elements until note, chord or ftrem is found. It can be used to look into neighboring layers as well, but only the first element will be checked.


The documentation for this class was generated from the following file: