GUIDOLib  1.7.7
Guido Engine Internal Documentation
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ARMusicalTag Class Reference

The base class for all musical tag classes. More...

Inheritance diagram for ARMusicalTag:
ARMusicalObject ARVisitable ARBase ARBeamState ARMerge ARMTParameter ARNewPage ARPossibleBreak ARSecondGlue ARTDummy

Public Types

enum  ORDER {
  kDontMove =-1, kStartOrder, kStaffOrder, kInstrumentOrder,
  kClefOrder, kKeyOrder, kMeterOrder, kTitleOrder,
  kComposerOrder, kFooterOrder, kSystemFormatOrder, kAccoladeOrder,
  kDefaultOrder
}
 
enum  ASSOCIATION {
  LA, RA, DC, EL,
  ER
}
 
enum  RANGE { NO, ONLY, RANGEDC }
 

Public Member Functions

 ARMusicalTag (const TYPE_TIMEPOSITION &tp, const ARMusicalTag *copy=0)
 
 ARMusicalTag (int pid=-1, const ARMusicalTag *copy=0)
 
virtual ~ARMusicalTag ()
 
virtual void accept (ARVisitor &visitor)
 
virtual int getOrder () const
 
virtual bool MatchEndTag (const char *endstr)
 
void setAllowRange (int pallow)
 
virtual const char * getTagName () const
 
virtual std::string getGMNName () const
 
virtual const char * getParamsStr () const
 
void setIsAuto (bool isauto)
 
bool getIsAuto () const
 
void print (std::ostream &os) const
 
void setAssociation (ASSOCIATION p_assoc)
 
ASSOCIATION getAssociation () const
 
virtual RANGE getRangeSetting () const
 
virtual bool IsStateTag () const
 
virtual void setError (int i=1)
 
virtual int getError () const
 
int getID () const
 
void setID (int pid)
 
virtual void setRange (bool p)
 
virtual bool getRange () const
 
void setColor (const char *cp)
 
void setRGBColor (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
 
void setSize (float newsize)
 
virtual const TagParameterFloat * getSize () const
 
const TagParameterString * getColor () const
 
const TagParameterRGBColor * getRGBColor () const
 
const TagParameterFloat * getDX () const
 
const TagParameterFloat * getDY () const
 
const ARMusicalObject * isARMusicalTag () const
 
template<typename T >
const T * getParameter (const char *param, bool usedefault=false) const
 
template<typename T >
const T * getParameter (const char *name1, const char *name2) const
 
template<typename T >
const T * getDefaultParameter (const char *param) const
 
virtual void setTagParameters (TagParametersList &params)
 
virtual void clearTagDefaultParameter (const char *param)
 
virtual void setTagParameters (const TagParameterMap &params)
 
virtual const TagParameterMap & getTagParameters () const
 
virtual const TagParameterMap & getSupportedTagParameters () const
 
virtual void addTagParameter (STagParameterPtr param)
 
virtual void copyParameters (const TagParameterMap &map)
 
virtual void setupTagParameters (const TagParameterMap &map)
 
virtual void setIsInHeader (bool state)
 
virtual bool isInHeader () const
 
- Public Member Functions inherited from ARMusicalObject
 ARMusicalObject ()
 
 ARMusicalObject (const TYPE_TIMEPOSITION &relativeTimepositionOfMusicalObject)
 
 ARMusicalObject (const ARMusicalObject &armo)
 
virtual ~ARMusicalObject ()
 
virtual ARMusicalObject * Copy () const
 
virtual const TYPE_DURATION & getDuration () const
 
virtual const TYPE_TIMEPOSITION & getRelativeTimePosition () const
 
virtual TYPE_TIMEPOSITION getRelativeEndTimePosition () const
 
virtual void setRelativeTimePosition (const TYPE_TIMEPOSITION &newRelativeTimePosition)
 
virtual void setRelativeEndTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual void setDuration (const TYPE_DURATION &dur)
 
virtual bool isEventClass () const
 
virtual void browse (TimeUnwrap &mapper) const
 
virtual int getVoiceNum () const
 
virtual void printGMNName (std::ostream &os) const
 
virtual void setVoiceNum (int num)
 
virtual void setDrawGR (bool on)
 
virtual bool getDrawGR () const
 
virtual ARMusicalObject * isARRepeatBegin ()
 
virtual ARNote * isARNote ()
 
virtual const ARNote * isARNote () const
 
virtual ARTab * isARTab ()
 
virtual const ARTab * isARTab () const
 
virtual ARMusicalObject * isARCoda ()
 
virtual ARMusicalObject * isARSegno ()
 
virtual ARMusicalObject * isARNewPage ()
 
virtual ARMusicalObject * isARNewSystem ()
 
virtual ARMusicalObject * isARKey ()
 
virtual ARMusicalObject * isARNaturalKey ()
 
virtual ARMusicalObject * isARBeamState ()
 
virtual ARMusicalObject * isARClef ()
 
virtual ARMusicalObject * isARFinishBar ()
 
virtual ARMusicalObject * isARMeter ()
 
virtual ARMusicalObject * isARRepeatEnd ()
 
virtual ARMusicalObject * isARRest ()
 
virtual ARMusicalObject * isARSecondGlue ()
 
virtual ARMusicalObject * isARPossibleBreak ()
 
virtual AROctava * isAROctava ()
 
virtual ARGrace * isARGrace ()
 
virtual ARSpace * isARSpace ()
 
virtual ARTempo * isARTempo ()
 
virtual const ARMusicalObject * isARDummyRangeEnd () const
 
virtual const ARMusicalObject * isARNoteFormat () const
 
virtual const ARMusicalObject * isARBar () const
 
virtual const ARMusicalObject * isARStaff () const
 
virtual const ARMusicalObject * isARJump () const
 
virtual const ARMusicalObject * isARChordComma () const
 
virtual const ARMusicalObject * isARUserChordTag () const
 
virtual bool isEmptyNote () const
 
- Public Member Functions inherited from ARVisitable
 ARVisitable ()
 
virtual ~ARVisitable ()
 

Protected Member Functions

virtual TagParameterMap checkTagParameters (TagParametersList &params, const std::string pTemplate)
 
virtual void checkUnitParameters (TagParameterMap &map)
 

Protected Attributes

int id
 
bool isAuto
 
ASSOCIATION assoc
 
RANGE rangesetting
 
int error
 
bool mHasRange
 
- Protected Attributes inherited from ARMusicalObject
TYPE_TIMEPOSITION relativeTimePosition
 
int fVoiceNum
 
bool fDrawGR = true
 

Additional Inherited Members

- Static Public Member Functions inherited from ARMusicalObject
static bool IsPowerOfTwoDenom (const TYPE_DURATION &dur)
 

Detailed Description

The base class for all musical tag classes.

It stores common tag data and offers common tag functions.

Member Enumeration Documentation

◆ ASSOCIATION

enum ARMusicalTag::ASSOCIATION
Enumerator
LA 
RA 
DC 
EL 
ER 

◆ ORDER

enum ARMusicalTag::ORDER
Enumerator
kDontMove 
kStartOrder 
kStaffOrder 
kInstrumentOrder 
kClefOrder 
kKeyOrder 
kMeterOrder 
kTitleOrder 
kComposerOrder 
kFooterOrder 
kSystemFormatOrder 
kAccoladeOrder 
kDefaultOrder 

◆ RANGE

enum ARMusicalTag::RANGE
Enumerator
NO 
ONLY 
RANGEDC 

Constructor & Destructor Documentation

◆ ARMusicalTag() [1/2]

ARMusicalTag::ARMusicalTag ( const TYPE_TIMEPOSITION &  tp,
const ARMusicalTag *  copy = 0 
)

◆ ARMusicalTag() [2/2]

ARMusicalTag::ARMusicalTag ( int  pid = -1,
const ARMusicalTag *  copy = 0 
)

◆ ~ARMusicalTag()

virtual ARMusicalTag::~ARMusicalTag ( )
inlinevirtual

Member Function Documentation

◆ accept()

virtual void ARMusicalTag::accept ( ARVisitor &  visitor)
inlinevirtual

Reimplemented from ARMusicalObject.

◆ addTagParameter()

virtual void ARMusicalTag::addTagParameter ( STagParameterPtr  param)
inlinevirtual

◆ checkTagParameters()

virtual TagParameterMap ARMusicalTag::checkTagParameters ( TagParametersList &  params,
const std::string  pTemplate 
)
protectedvirtual

Reimplemented in ARPageFormat.

◆ checkUnitParameters()

virtual void ARMusicalTag::checkUnitParameters ( TagParameterMap &  map)
protectedvirtual

◆ clearTagDefaultParameter()

virtual void ARMusicalTag::clearTagDefaultParameter ( const char *  param)
virtual

◆ copyParameters()

virtual void ARMusicalTag::copyParameters ( const TagParameterMap &  map)
inlinevirtual

◆ getAssociation()

ASSOCIATION ARMusicalTag::getAssociation ( ) const
inline

◆ getColor()

const TagParameterString* ARMusicalTag::getColor ( ) const

◆ getDefaultParameter()

template<typename T >
const T* ARMusicalTag::getDefaultParameter ( const char *  param) const
inline

◆ getDX()

const TagParameterFloat* ARMusicalTag::getDX ( ) const

◆ getDY()

const TagParameterFloat* ARMusicalTag::getDY ( ) const

◆ getError()

virtual int ARMusicalTag::getError ( ) const
inlinevirtual

◆ getGMNName()

virtual std::string ARMusicalTag::getGMNName ( ) const
inlinevirtual

Reimplemented from ARMusicalObject.

Reimplemented in ARTrill, ARAuto, ARTStem, ARTHead, ARTempo, ARTitle, ARMeter, ARClef, ARTremolo, ARTuplet, ARKey, ARLyrics, ARFingering, ARPageFormat, ARUnits, ARAccolade, ARDaCapoAlFine, ARDalSegnoAlFine, ARFeatheredBeam, ARIntens, AROctava, ARBeam, ARHarmony, ARInstrument, ARRitardando, ARStaff, ARStaffFormat, ARMark, ARBar, ARSlur, ARText, ARAlter, ARBarFormat, ARComposer, ARDisplayDuration, ARNoteFormat, ARStaccato, ARAccelerando, ARArpeggio, ARAccidental, ARFermata, ARGlissando, ARCrescendo, ARSpecial, ARSymbol, ARCluster, ARMMRest, ARNotations, ARRestFormat, ARCue, ARFooter, ARPizzicato, ARSystemFormat, ARBow, ARDiminuendo, ARStaffOff, ARDaCapo, ARDalSegno, ARSpace, ARTie, ARVolta, ARTenuto, ARAccent, ARMarcato, ARDotFormat, ARFinishBar, ARStaffOn, ARDoubleBar, ARGrace, ARBowing, ARRepeatEnd, ARFine, ARMerge, ARNewPage, ARNewSystem, ARRepeatBegin, ARBreathMark, ARHarmonic, ARSegno, ARCoda, ARDaCoda, ARUserChordTag, ARArticulation, ARAutoBeam, ARTagEnd, ARChordTag, ARShareLocation, ARShareStem, ARChordComma, ARColor, ARAutoBeamEnd, ARDrHoos, ARDrRenz, ARDummyRangeEnd, ARLabel, ARSecondGlue, ARBase, ARPossibleBreak, ARRepeatEndRangeEnd, ARTagBegin, ARDefineTag, and ARTDummy.

◆ getID()

int ARMusicalTag::getID ( ) const
inline

◆ getIsAuto()

bool ARMusicalTag::getIsAuto ( ) const
inline

◆ getOrder()

virtual int ARMusicalTag::getOrder ( ) const
inlinevirtual

Reimplemented in ARTitle, ARMeter, ARClef, ARKey, ARAccolade, ARInstrument, ARStaff, ARComposer, ARFooter, ARSystemFormat, ARSpace, ARStaffOff, and ARStaffOn.

◆ getParameter() [1/2]

template<typename T >
const T* ARMusicalTag::getParameter ( const char *  name1,
const char *  name2 
) const
inline

◆ getParameter() [2/2]

template<typename T >
const T* ARMusicalTag::getParameter ( const char *  param,
bool  usedefault = false 
) const
inline

◆ getParamsStr()

virtual const char* ARMusicalTag::getParamsStr ( ) const
inlinevirtual

Reimplemented in ARTrill, ARAuto, ARTStem, ARTempo, ARTitle, ARMeter, ARClef, ARTremolo, ARTuplet, ARKey, ARLyrics, ARPageFormat, ARUnits, ARAccolade, ARFeatheredBeam, ARIntens, AROctava, ARBeam, ARHarmony, ARInstrument, ARRitardando, ARStaff, ARStaffFormat, ARMark, ARBar, ARBeamState, ARText, ARAlter, ARBarFormat, ARComposer, ARDisplayDuration, ARNoteFormat, ARStaccato, ARAccelerando, ARArpeggio, ARAccidental, ARFermata, ARGlissando, ARSpecial, ARSymbol, ARCluster, ARMMRest, ARRestFormat, ARCue, ARFooter, ARPizzicato, ARBow, ARStaffOff, ARSpace, ARVolta, ARDotFormat, ARStaffOn, ARGrace, ARBowing, ARMerge, ARBreathMark, ARSegno, ARArticulation, ARChordTag, ARDynamic, ARShareLocation, ARShareStem, ARChordComma, ARColor, ARDrHoos, ARDrRenz, ARJump, ARLabel, ARNaturalKey, ARSecondGlue, ARFontAble, ARPossibleBreak, and ARRepeatEndRangeEnd.

◆ getRange()

virtual bool ARMusicalTag::getRange ( ) const
inlinevirtual

◆ getRangeSetting()

virtual RANGE ARMusicalTag::getRangeSetting ( ) const
inlinevirtual

◆ getRGBColor()

const TagParameterRGBColor* ARMusicalTag::getRGBColor ( ) const

◆ getSize()

virtual const TagParameterFloat* ARMusicalTag::getSize ( ) const
virtual

Reimplemented in ARStaffFormat.

◆ getSupportedTagParameters()

virtual const TagParameterMap& ARMusicalTag::getSupportedTagParameters ( ) const
inlinevirtual

◆ getTagName()

virtual const char* ARMusicalTag::getTagName ( ) const
inlinevirtual

Reimplemented in ARTrill, ARAuto, ARTStem, ARTHead, ARTempo, ARTitle, ARMeter, ARClef, ARTremolo, ARTuplet, ARKey, ARLyrics, ARFingering, ARPageFormat, ARUnits, ARAccolade, ARDaCapoAlFine, ARDalSegnoAlFine, ARFeatheredBeam, ARIntens, AROctava, ARBeam, ARHarmony, ARInstrument, ARRitardando, ARStaff, ARStaffFormat, ARMark, ARBar, ARBeamState, ARSlur, ARText, ARAlter, ARBarFormat, ARComposer, ARDisplayDuration, ARNoteFormat, ARStaccato, ARAccelerando, ARArpeggio, ARAccidental, ARFermata, ARGlissando, ARCrescendo, ARSpecial, ARSymbol, ARCluster, ARMMRest, ARNotations, ARRestFormat, ARCue, ARFooter, ARPizzicato, ARSystemFormat, ARBow, ARDiminuendo, ARStaffOff, ARDaCapo, ARDalSegno, ARSpace, ARTie, ARVolta, ARTenuto, ARAccent, ARMarcato, ARDotFormat, ARFinishBar, ARStaffOn, ARDoubleBar, ARGrace, ARBowing, ARRepeatEnd, ARFine, ARMerge, ARNewPage, ARNewSystem, ARRepeatBegin, ARBreathMark, ARHarmonic, ARSegno, ARCoda, ARDaCoda, ARUserChordTag, ARArticulation, ARAutoBeam, ARTagEnd, ARChordTag, ARDynamic, ARShareLocation, ARShareStem, ARChordComma, ARColor, ARAutoBeamEnd, ARDrHoos, ARDrRenz, ARDummyRangeEnd, ARJump, ARLabel, ARNaturalKey, ARSecondGlue, ARPossibleBreak, ARRepeatEndRangeEnd, ARTagBegin, ARDefineTag, and ARTDummy.

◆ getTagParameters()

virtual const TagParameterMap& ARMusicalTag::getTagParameters ( ) const
inlinevirtual

◆ isARMusicalTag()

const ARMusicalObject* ARMusicalTag::isARMusicalTag ( ) const
inlinevirtual

Reimplemented from ARMusicalObject.

◆ isInHeader()

virtual bool ARMusicalTag::isInHeader ( ) const
inlinevirtual

◆ IsStateTag()

virtual bool ARMusicalTag::IsStateTag ( ) const
inlinevirtual

Reimplemented in ARAuto, ARTHead, ARTStem, ARMeter, ARClef, ARKey, ARBarFormat, ARInstrument, ARNoteFormat, ARUnits, ARAccolade, ARPageFormat, ARStaff, ARBeamState, ARStaffFormat, AROctava, ARAlter, ARRestFormat, ARSystemFormat, ARDotFormat, ARSecondGlue, and ARColor.

◆ MatchEndTag()

virtual bool ARMusicalTag::MatchEndTag ( const char *  endstr)
virtual

Reimplemented in ARTrill, ARTuplet, ARFeatheredBeam, ARGlissando, ARBeam, ARSlur, ARTremolo, ARRitardando, ARVolta, ARArpeggio, ARDisplayDuration, ARCrescendo, ARAccelerando, ARDiminuendo, ARStaccato, and ARTie.

◆ print()

void ARMusicalTag::print ( std::ostream &  os) const
virtual

Reimplemented from ARMusicalObject.

◆ setAllowRange()

void ARMusicalTag::setAllowRange ( int  pallow)

◆ setAssociation()

void ARMusicalTag::setAssociation ( ASSOCIATION  p_assoc)
inline

◆ setColor()

void ARMusicalTag::setColor ( const char *  cp)

◆ setError()

virtual void ARMusicalTag::setError ( int  i = 1)
inlinevirtual

Reimplemented in ARMerge.

◆ setID()

void ARMusicalTag::setID ( int  pid)
inline

◆ setIsAuto()

void ARMusicalTag::setIsAuto ( bool  isauto)
inline

◆ setIsInHeader()

virtual void ARMusicalTag::setIsInHeader ( bool  state)
inlinevirtual

◆ setRange()

virtual void ARMusicalTag::setRange ( bool  p)
inlinevirtual

◆ setRGBColor()

void ARMusicalTag::setRGBColor ( unsigned char  red,
unsigned char  green,
unsigned char  blue,
unsigned char  alpha = 255 
)

◆ setSize()

void ARMusicalTag::setSize ( float  newsize)

◆ setTagParameters() [1/2]

virtual void ARMusicalTag::setTagParameters ( const TagParameterMap &  params)
inlinevirtual

Reimplemented in ARTrill, ARAuto, ARClef, ARMeter, ARKey, ARTuplet, ARFeatheredBeam, ARBeam, ARLyrics, ARMark, ARPageFormat, ARUnits, ARBar, ARFingering, ARComposer, ARDisplayDuration, ARArpeggio, ARStaffFormat, ARInstrument, AROctava, ARCluster, ARIntens, ARBarFormat, ARHarmony, ARText, ARFermata, ARGlissando, ARSpace, ARStaccato, ARSpecial, ARPizzicato, ARBow, ARBowing, ARJump, ARArticulation, ARDynamic, TempoChange, ARColor, ARFontAble, ARTempo, and ARTremolo.

◆ setTagParameters() [2/2]

virtual void ARMusicalTag::setTagParameters ( TagParametersList &  params)
virtual

◆ setupTagParameters()

virtual void ARMusicalTag::setupTagParameters ( const TagParameterMap &  map)
inlinevirtual

Member Data Documentation

◆ assoc

ASSOCIATION ARMusicalTag::assoc
protected

◆ error

int ARMusicalTag::error
protected

◆ id

int ARMusicalTag::id
protected

◆ isAuto

bool ARMusicalTag::isAuto
protected

◆ mHasRange

bool ARMusicalTag::mHasRange
protected

◆ rangesetting

RANGE ARMusicalTag::rangesetting
protected
Guido Project Copyright © 2019 Grame-CNCM