musx::dom::TimeSignature Class Reference

Shared time signature class that is derived from other classes. (See others::Measure) More...

#include <CommonClasses.h>

Inheritance diagram for musx::dom::TimeSignature:

Classes
struct	TimeSigComponent
	A single time signature component. More...

Public Member Functions
std::pair< util::Fraction, NoteType >	calcSimplified () const
	Calculates the simplest form of of this time signature, expressed as a fractional count of NoteType units.
util::Fraction	calcTotalDuration () const
	Calculates the total duration of the time signature as a fraction of a whole note.
bool	isSame (const TimeSignature &src)
	returns whether the two time signatures represent the same time signature
std::shared_ptr< TimeSignature >	createComponent (size_t index) const
	Creates a time signature corresponding to the component at index.
std::optional< char32_t >	getAbbreviatedSymbol () const
	Returns the abbreviated symbol (code point) for this time signature, or std::nullopt if none.
bool	isCommonTime () const
	Returns if this time signature is common time.
bool	isCutTime () const
	Returns if this time signature is cut time.
Public Member Functions inherited from musx::dom::CommonClassBase
	CommonClassBase (const DocumentWeakPtr &document)
	Constructs a CommonClassBase object.
Public Member Functions inherited from musx::dom::Base
virtual	~Base () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getPartId () const
	Gets the partId for this instance (or 0 for score)
std::shared_ptr< others::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.
ShareMode	getShareMode () const
	Gets the sharing mode for this instance.
const SharedNodes &	getUnlinkedNodes () const
	Gets the unlinked nodes for this instance. (Only populated for ShareMode::Partial)
void	addUnlinkedNode (const std::string &nodeName)
	Adds a shared node for this instance.
virtual void	integrityCheck ()
	Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes.
virtual bool	requireAllFields () const
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Public Attributes
std::vector< TimeSigComponent >	components
	the components in the time signature

Friends
class	others::Measure
class	details::IndependentStaffDetails

Additional Inherited Members
Public Types inherited from musx::dom::Base
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...
using	SharedNodes = std::set< std::string >
	The container type for shared nodes.
Protected Member Functions inherited from musx::dom::CommonClassBase
std::shared_ptr< others::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.
Cmper	getPartId () const
	Gets the partId for this instance (or 0 for score)
ShareMode	getShareMode () const
	Gets the sharing mode for this instance.
const SharedNodes &	getUnlinkedNodes () const
	Gets the unlinked nodes for this instance. (Only populated for ShareMode::Partial)
Protected Member Functions inherited from musx::dom::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Shared time signature class that is derived from other classes. (See others::Measure)

Member Function Documentation

calcSimplified()

std::pair< util::Fraction, NoteType > musx::dom::TimeSignature::calcSimplified

(

)

const

Calculates the simplest form of of this time signature, expressed as a fractional count of NoteType units.

In typical cases, the returned util::Fraction has a denominator of 1, but Finale supports other kinds of fractions. Use util::Fraction::quotient to get the integer value and util::Fraction::remainder to get the residual fractional component.

createComponent()

std::shared_ptr< TimeSignature > musx::dom::TimeSignature::createComponent ( size_t  index ) const

inline

Creates a time signature corresponding to the component at index.

Parameters

index

The 0-based component index

Exceptions

std::invalid_argument

if index is out of range

getAbbreviatedSymbol()

std::optional< char32_t > musx::dom::TimeSignature::getAbbreviatedSymbol

(

)

const

Returns the abbreviated symbol (code point) for this time signature, or std::nullopt if none.

If the musx document lacks music symbol options but abbreviation was requested, the SMuFL values are returned as default substitute values.