Represents the Measure Number Region with detailed font and enclosure settings for score and part data. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::MeasureNumberRegion:

Classes
class	ScorePartData
	Measure number data that can differ in score or part. More...

Public Types
enum class	TimePrecision { WholeSeconds , Tenths , Hundredths , Thousandths }
	Precision for time display. More...

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.

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

bool	calcIncludesMeasure (MeasCmper measureId) const
	Calculates whether the input measure is covered by this measure number region.

int	getStartNumber () const
	Returns the starting display measure number for this region. The value is irrespective of whether the number actually displays on the first measure of the region. (This depends on Measure::noMeasNum.) The starting number appears on the first measure in the region that is included in measure numbering.

std::optional< int >	calcDisplayNumberFor (MeasCmper measureId) const
	Returns the visible number for a measure id with respect to the region.

std::optional< int >	calcLastDisplayNumber () const
	Returns the last visible number in the region. This function takes into account if the last measure is not included and falls back to the previous measure if so. (And repeats if necessary.)

void	integrityCheck (const std::shared_ptr< Base > &ptrToThis) 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
	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::Base
virtual	~Base () noexcept(false)=default
	Virtual destructor for polymorphic behavior.

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

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
	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< MeasureNumberRegion > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
std::shared_ptr< ScorePartData >	scoreData
	Score-wide measure number data.

std::shared_ptr< ScorePartData >	partData
	Part-specific measure number data.

MeasCmper	startMeas {}
	Starting measure number for the region.

MeasCmper	endMeas {}
	Ending measure number for the region (non-inclusive).

char32_t	startChar {}
	UTF-32 code for the first character in the sequence. (Frequently '0', 'a', or 'A')

int	base {}
	The base used for measure number calculations. (Frequently 10 for numeric or 26 for alpha)

int	numberOffset {}
	This value is 1 less than the "Starting Number" field in the Finale UI. (xml node is `<offset>`)

std::string	prefix
	Text prefix for measure numbers (encoded UTF-8).

std::string	suffix
	Text suffix for measure numbers (encoded UTF-8).

bool	countFromOne {}
	Start counting from 1 rather than 0, e.g., "1, 2, 3, 4" numbering style (in conjuction with base 10)

bool	noZero
	Indicates the base has no zero value: true for alpha sequences and false for numeric sequences.

bool	doubleUp {}
	Indicates "a, b, c...aa, bb, cc" number style: the symbols are repeated when they exceed the base.

bool	time {}
	Display real time sequences rather than numbers or letters.

bool	includeHours {}
	Display hours (when showing real time measure numbers)

bool	smpteFrames {}
	SMPTE frames (when showing real time measure numbers). This option supercedes `timePrecision`.

bool	useScoreInfoForPart {}
	Use score-wide settings for parts.

int	region {}
	The region ID. This 1-based value is set by Finale and never changes, whereas the Cmper may change when Finale sorts the regions.

TimePrecision	timePrecision {}
	Precision for real-time sequences.

bool	hideScroll {}
	Indicates if numbers are hidden in Scroll View and Studio View.

bool	hidePage {}
	Indicates if numbers are hidden in Page View.

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

Additional Inherited Members
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::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.

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

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

Base &	operator= (const Base &)
	no-op copy assignment operator allows subclasses to copy their values.

Base &	operator= (Base &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Represents the Measure Number Region with detailed font and enclosure settings for score and part data.

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

Member Enumeration Documentation

◆ TimePrecision

enum class musx::dom::others::MeasureNumberRegion::TimePrecision

strong

Precision for time display.

Enumerator
WholeSeconds	the default value

Member Function Documentation

◆ calcDisplayNumberFor()

std::optional< int > musx::dom::others::MeasureNumberRegion::calcDisplayNumberFor ( MeasCmper measureId ) const

Returns the visible number for a measure id with respect to the region.

Returns: The display number or std::nullopt if the measure is not included in measure numbering

Exceptions

std::logic_error if measureId is not contained in the region

◆ calcIncludesMeasure()

bool musx::dom::others::MeasureNumberRegion::calcIncludesMeasure ( MeasCmper measureId ) const

inline

Calculates whether the input measure is covered by this measure number region.

Parameters

measureId The measure id to check.

◆ calcLastDisplayNumber()

std::optional< int > musx::dom::others::MeasureNumberRegion::calcLastDisplayNumber ( ) const

Returns the last visible number in the region. This function takes into account if the last measure is not included and falls back to the previous measure if so. (And repeats if necessary.)

Returns: The last visible number or std::nullopt if no measure in the region is included in numbering. (See Measure::noMeasNum.)

◆ integrityCheck()

void musx::dom::others::MeasureNumberRegion::integrityCheck ( const std::shared_ptr< Base > & ptrToThis )

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.

Parameters

ptrToThis This instance in a shared_ptr. (Avoids need for shared_from_this.)

Exceptions

musx::dom::integrity_error if there is a problem.

Reimplemented from musx::dom::Base.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members