musx::dom::others::MultimeasureRest Class Reference

Represents the attributes of a multimeasure rest in the page layout. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::MultimeasureRest:

Public Member Functions
	MultimeasureRest (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper startMeasure)
	Constructor function.
MeasCmper	getStartMeasure () const
	Get the start measure of this multimeasure rest.
int	calcNumberOfMeasures () const
	Calculates the number of measures spanned by this multimeasure rest.
bool	calcIsNumberVisible () const
	Calculates if the number on this multimeasure rest is visible.
void	integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis) override
	Performs a final consistency check after population.
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.
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 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< MultimeasureRest > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	measWidth {}
	Width of the multemeasure rest "measure" in Evpu. (xml node is <meaSpace>)
MeasCmper	nextMeas {}
	Next measure after the multimeasure west.
Evpu	numVertAdj {}
	Vertical number adjustment, sign-revered from Finale UI. (xml node is <numdec>)
Cmper	shapeDef {}
	Cmper of Shape Designer ShapeDef that specifies the H-bar.
int	numStart {}
int	symbolThreshold {}
	If the number of rests is less than this value, symbols are used when useSymbols is true. (xml node is <threshold>)
Evpu	symbolSpacing {}
	Spacing between symbols in Evpu. (xml node is <spacing>)
Evpu	numHorzAdj {}
	Horizontal number adjustment in Evpu. (xml node is <numAdjX>)
Evpu	shapeStartAdjust {}
	Start adjustment for the H-bar shape in Evpu. (xml node is <startAdjust>)
Evpu	shapeEndAdjust {}
	End adjustment for the shape in Evpu. (xml node is <endAdjust>)
bool	useSymbols {}
	Use symbols instead of an H-bar, based on symbolThreshold. (xml node is <useCharRestStyle>)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "mmRest"
	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...
using	SharedNodes = std::set< std::string >
	The container type for shared nodes.
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)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
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 &)
	no-op copy assignment operator allows subclasses to copy their values.
EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.
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 &)
	no-op copy assignment operator allows subclasses to copy their values.
DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Represents the attributes of a multimeasure rest in the page layout.

The Cmper is the first measure of the multimeasure rest.

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

Member Function Documentation

integrityCheck()

void musx::dom::others::MultimeasureRest::integrityCheck ( const std::shared_ptr< EnigmaBase > &  ptrToThis )

inlineoverridevirtual

Performs a final consistency check after population.

Reimplemented from musx::dom::EnigmaBase.

Member Data Documentation

numStart

int musx::dom::others::MultimeasureRest::numStart {}

Number start value. If the number of measures in the multimeasure rest is fewer than this number, no number appears on the multimeasure rest.