musx::dom::others::PartGlobals Class Reference

Represents global values that can vary by part. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::PartGlobals:

Public Member Functions
	PartGlobals (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
Cmper	calcScrollViewCmper () const
	Return the StaffUsed cmper for Scroll View for this part.
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 void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	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.

Static Public Member Functions
static const xml::XmlElementArray< PartGlobals > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
bool	showTransposed {}
	If true, "Display Concert Pitch" is unchecked for the part.
Cmper	scrollViewIUlist {}
	If this value is non-zero, it is the iuList Cmper of the current Staff List in Scroll View.
Cmper	studioViewIUlist {}
	The iuList Cmper for Studio View.
Cmper	specialPartExtractionIUList {}
	If non-zero, Special Part Extraction is enabled and this is the Cmper for its legacy StaffUsed array.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "partGlobals"
	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.
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 global values that can vary by part.

The cmper is always 65534.

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

Member Function Documentation

calcScrollViewCmper()

Cmper musx::dom::others::PartGlobals::calcScrollViewCmper

(

)

const

Return the StaffUsed cmper for Scroll View for this part.

Returns

Either BASE_SYSTEM_ID or the specialPartExtractionIUList.

Member Data Documentation

specialPartExtractionIUList

Cmper musx::dom::others::PartGlobals::specialPartExtractionIUList {}

If non-zero, Special Part Extraction is enabled and this is the Cmper for its legacy StaffUsed array.

In older (pre-optimization) Finale files, this Cmper identified the staff list used for Page View layout of an extracted part. In modern Finale, including all versions that produce musx rather than legacy mus, every system is fully optimized and maintains its own system-level staff list. As a result, this value is no longer consulted when constructing Page View systems.

Its only remaining purpose is as a flag that Special Part Extraction is active, and as a filter for the Finale UI: it limits which staves may be added to a Page View system when the user is working in the extracted-part layout.

(xml node is <pageViewIUlist>)