ARBarFormat Class Reference

the bar format tag parameter. More...

Inheritance diagram for ARBarFormat:

Public Types
enum	style { kStyleStaff, kStyleSystem, kStyleRange }
typedef std::vector< std::pair< int, int > >	TRanges
Public Types inherited from ARMusicalTag
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
	ARBarFormat ()
	ARBarFormat (const ARBarFormat &)
virtual	~ARBarFormat ()
virtual void	setTagParameters (const TagParameterMap &params)
virtual const char *	getParamsStr () const
virtual const char *	getTagName () const
virtual std::string	getGMNName () const
style	getStyle () const
const ARBar::TRanges &	getRanges () const
virtual bool	IsStateTag () const
Public Member Functions inherited from ARMTParameter
	ARMTParameter (const TYPE_TIMEPOSITION &tp, const ARMTParameter *copy=0)
	ARMTParameter (int pid=-1, const ARMTParameter *copy=0)
virtual	~ARMTParameter ()
Public Member Functions inherited from ARMusicalTag
	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)
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 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 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
ARBar::TRanges	getRanges (const NVstring &str)
Protected Member Functions inherited from ARMusicalTag
virtual TagParameterMap	checkTagParameters (TagParametersList &params, const std::string pTemplate)
virtual void	checkUnitParameters (TagParameterMap &map)

Protected Attributes
style	fStyle
ARBar::TRanges	fRanges
Protected Attributes inherited from ARMusicalTag
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 bar format tag parameter.

Member Typedef Documentation

TRanges

typedef std::vector<std::pair<int, int> > ARBarFormat::TRanges

Member Enumeration Documentation

style

enum ARBarFormat::style

Enumerator
kStyleStaff
kStyleSystem
kStyleRange

Constructor & Destructor Documentation

ARBarFormat() [1/2]

ARBarFormat::ARBarFormat

(

)

ARBarFormat() [2/2]

ARBarFormat::ARBarFormat

(

const ARBarFormat &

)

~ARBarFormat()

virtual ARBarFormat::~ARBarFormat ( )

inlinevirtual

Member Function Documentation

getGMNName()

virtual std::string ARBarFormat::getGMNName ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

getParamsStr()

virtual const char* ARBarFormat::getParamsStr ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

getRanges() [1/2]

const ARBar::TRanges& ARBarFormat::getRanges ( ) const

inline

getRanges() [2/2]

ARBar::TRanges ARBarFormat::getRanges ( const NVstring &  str )

protected

getStyle()

style ARBarFormat::getStyle ( ) const

inline

getTagName()

virtual const char* ARBarFormat::getTagName ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

IsStateTag()

virtual bool ARBarFormat::IsStateTag ( ) const

inlinevirtual

Reimplemented from ARMusicalTag.

setTagParameters()

virtual void ARBarFormat::setTagParameters ( const TagParameterMap &  params )

virtual

Reimplemented from ARMusicalTag.

Member Data Documentation

fRanges

ARBar::TRanges ARBarFormat::fRanges

protected

fStyle

style ARBarFormat::fStyle

protected