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 () override
	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.
Public Member Functions inherited from musx::dom::OthersBase
Cmper	getCmper () const
	Gets the cmper key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
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 bool	requireAllFields () const
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

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::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::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase object.
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

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 ( )

inlineoverridevirtual

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.

The default implementation should always be called inside an overridden implementation.

Exceptions

musx::dom::integrity_error

if there is a problem.

Reimplemented from musx::dom::Base.

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.