musx::dom::others::StaffSystem Class Reference

Represents the attributes of a staff system in the page layout. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::StaffSystem:

Public Member Functions
	StaffSystem (const DocumentWeakPtr &document, Cmper staffSystemId, ShareMode shareMode, Cmper cmper)
	Constructor function.
MeasCmper	getLastMeasure () const
	Encapsulates the weird Finale fact that endMeas is actually one past the end of the system.
int	calcNumMeasures () const
	Calculates the number of measures on the system, encapsulating how endMeas works.
MusxInstance< others::Page >	getPage () const
	Gets the page this system is on.
util::Fraction	calcSystemScaling () const
	Calculate the system scaling.
util::Fraction	calcEffectiveScaling () const
	Calculates the effective scaling on this system, taking into account page scaling.
std::pair< util::Fraction, util::Fraction >	calcMinMaxStaffSizes () const
	Calculates the maximum and minimum staff scaling values for this system by searching each staff for individual staff scaling.
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< StaffSystem > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
MeasCmper	startMeas {}
	Starting measure of the staff system. See Measure.
MeasCmper	endMeas {}
double	horzPercent {}
int	ssysPercent {}
	Staff system scaling percentage (100 means no scaling).
Efix	staffHeight {}
	Staff height in Efix units. Note that this is different units than options::PageFormatOptions::PageFormat::rawStaffHeight.
Evpu	top {}
	Top margin in Evpu. (Sign reversed in Finale UI.)
Evpu	left {}
	Left margin in Evpu.
Evpu	right {}
	Right margin in Evpu. (Sign reversed in Finale UI.)
Evpu	bottom {}
bool	noNames {}
bool	hasStaffScaling {}
	Indicates if any individual staff in the system has scaling applied.
bool	placeEndSpaceBeforeBarline {}
	Indicates that extra space is placed before the barline.
bool	scaleVert {}
	"Resize Vertical Space"
bool	holdMargins {}
	"Hold Margins" (xml node is <scaleContentOnly>)
Evpu	distanceToPrev {}
	Distance to the previous staff system in Evpu.
Evpu	extraStartSystemSpace {}
	Extra space at the start of the staff system in Evpu.
Evpu	extraEndSystemSpace {}
	Extra space at the end of the staff system in Evpu.
PageCmper	pageId {}
	The page this system is on. This values is not in the xml but is computed by the factory.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "staffSystemSpec"
	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 staff system in the page layout.

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

Member Function Documentation

calcMinMaxStaffSizes()

std::pair< util::Fraction, util::Fraction > musx::dom::others::StaffSystem::calcMinMaxStaffSizes

(

)

const

Calculates the maximum and minimum staff scaling values for this system by searching each staff for individual staff scaling.

Returns

A std::pair containing

• util::Fraction: The scaling of the staff with the minimum (smallest) scaling factor
• util::Fraction: The scaling of the staff with the maximum (largest) scaling factor

calcNumMeasures()

int musx::dom::others::StaffSystem::calcNumMeasures ( ) const

inline

Calculates the number of measures on the system, encapsulating how endMeas works.

Returns

The number of measures on the system.

getLastMeasure()

MeasCmper musx::dom::others::StaffSystem::getLastMeasure ( ) const

inline

Encapsulates the weird Finale fact that endMeas is actually one past the end of the system.

Returns

The actual last measure on the system.

integrityCheck()

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

inlineoverridevirtual

Performs a final consistency check after population.

Reimplemented from musx::dom::EnigmaBase.

Member Data Documentation

bottom

Evpu musx::dom::others::StaffSystem::bottom {}

Bottom margin in Evpu. This value is 96 (i.e., 1 5-line staff thickness) less than the U.I. value. That means if you enter 0 in the Finale UI, this value is -96.

endMeas

MeasCmper musx::dom::others::StaffSystem::endMeas {}

The ending measure of the staff system, stored as one greater than the last measure on this system. In other words, it is the first measure of the next system, or one past the last measure in the document. See Measure. If endMeas is a split measure, its first part may still appear on this system depending on spacing. (Finale does not record this in the data.) If the system is locked, the first part of the split always appears on this system. See SplitMeasure and SystemLock.

horzPercent

double musx::dom::others::StaffSystem::horzPercent {}

Horizontal scaling percentage (fractional, 100.0 means no scaling). This value affects "stretchable" items such as word extensions on lyrics.

noNames

bool musx::dom::others::StaffSystem::noNames {}

Suppresses staff & group names along the left system margin. It does not appear to have a UI in Finale 27, but it works and it occasionally appears in musx files.