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.

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 void	integrityCheck ()
	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 in effect and this is the Cmper for its InstrumentUsed 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.

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 global values that can vary by part.

The cmper is always 65534.

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

Member Data Documentation

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

If non-zero, Special Part Extraction is in effect and this is the Cmper for its InstrumentUsed array.

When Special Part Extraction is in effect, staff systems no longer have their own instrument lists. Instead, they use this value.

(xml node is <pageViewIUlist>) If non-zero, Special Part Extraction is in effect and this is the iuList Cmper.