A single tempo change value entered with Finale's Tempo tool. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::TempoChange:

Public Member Functions
	TempoChange (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
	Constructor function.

double	getAbsoluteTempo (NoteType noteType=NoteType::Quarter) const
	Computes the absolute tempo represented by the TempoChange Instance.

Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor

	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor

Cmper	getCmper () const
	Gets the `cmper` key value.

std::optional< Inci >	getInci () const
	Gets the optional array index (`inci`).

Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.

Public Member Functions inherited from musx::dom::EnigmaBase
Cmper	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.

ShareMode	getShareMode () const
	Gets the sharing mode for this instance.

virtual void	integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.

virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.

Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.

DocumentPtr	getDocument () const
	Gets a reference to the Document.

Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static const xml::XmlElementArray< TempoChange > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	ratio {}

Edu	eduPosition {}
	The position within the measure. (xml node is `<eldur>`)

int	unit {}
	Hardware ticks/sec. For Macs this is 1000.

bool	isRelative {}

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "tempoDef"
	The XML node name for this type.

Additional Inherited Members
Public Types inherited from musx::dom::EnigmaBase
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...

Protected Member Functions inherited from musx::dom::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase object.

OthersBase &	operator= (const OthersBase &other)
	Copy assignment preserves the destination DOM instance's document, source and requested part IDs, sharing mode, cmper, and inci.

OthersBase &	operator= (OthersBase &&other) noexcept
	Move assignment preserves the destination DOM instance's document, source and requested part IDs, sharing mode, cmper, and inci.

Protected Member Functions inherited from musx::dom::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.

	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor

	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor

EnigmaBase &	operator= (const EnigmaBase &)
	Copy assignment preserves the destination DOM instance's document, source part, and sharing mode.

EnigmaBase &	operator= (EnigmaBase &&) noexcept
	Move assignment preserves the destination DOM instance's document, source part, and sharing mode.

Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.

	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor

	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor

DocumentElement &	operator= (const DocumentElement &)
	Copy assignment preserves the destination DOM instance's document and part ID.

DocumentElement &	operator= (DocumentElement &&) noexcept
	Move assignment preserves the destination DOM instance's document and part ID.

Detailed Description

A single tempo change value entered with Finale's Tempo tool.

Although the Finale UI dropped the Tempo tool around 2010, the notation engine still supported them. It was always possible (even as late as Finale 27.4) to add tempo changes using third-pary plugins.

The most common tool for creating TempoChange instances was the plugin JW Tempo. It only ever used absolute ratios, so the focus of this class is on them.

The cmper is the measure number, and incis should be stored in order by eduPosition.

This class is identified by the XML node name "tempoDef".

Member Function Documentation

◆ getAbsoluteTempo()

double musx::dom::others::TempoChange::getAbsoluteTempo ( NoteType noteType = NoteType::Quarter ) const

Computes the absolute tempo represented by the TempoChange Instance.

Parameters

noteType optional note type for which to get the beats per minute. (The default is NoteType::Quarter.)

Returns: The per minute value. Because ratio is an integer, it cannot encode most tempos exactly. The value returned is the shortest decimal that converts back to ratio, which states the encoded tempo without adding precision the encoding does not carry. It therefore usually has a fractional part, and callers that need a whole number must round it themselves.

Exceptions

std::logic_error if this instance represents a relative tempo.

Member Data Documentation

◆ isRelative

bool musx::dom::others::TempoChange::isRelative {}

A computed value that determines if ratio is relative or absolute. This value is not represented in the xml but instead captures whether the ratio property was populated from <relativeRatio> or <absoluteRatio>.

◆ ratio

int musx::dom::others::TempoChange::ratio {}

Absolute or relative ratio. Relative ratios are are a percent value * 10. 100% would have a value of 1000. See getAbsoluteTempo for how to use absolute ratios. The xml provides one of two nodes for this field: <relativeRatio> or <absoluteRatio>.

Public Member Functions

Static Public Member Functions

Public Attributes