musx::dom::others::PartDefinition Class Reference

Represents the attributes of a Finale "partDef". More...

#include <Others.h>

Inheritance diagram for musx::dom::others::PartDefinition:

Public Member Functions
	PartDefinition (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
std::string	getName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Get the part name if any.
bool	isScore () const
	Return true if this part corresponds to the score.
Cmper	calcSystemIuList (Cmper systemId) const
	Return the InstrumentUsed cmper by this part for the specified system.
bool	requireAllFields () const override
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
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.

Static Public Member Functions
static std::shared_ptr< PartDefinition >	getScore (const DocumentPtr &document)
	Return the instance for the score.
static std::vector< std::shared_ptr< PartDefinition > >	getInUserOrder (const DocumentPtr &document)
	Return the linked parts sorted in UI order by partOrder.
static const xml::XmlElementArray< PartDefinition > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Cmper	nameId {}
	Cmper of the part name TextBlock. (xml tag is <nameID>)
int	partOrder {}
	Value that determines the order of listed parts in Finale's UI.
int	copies {}
	Number of copies to print.
bool	extractPart {}
	Indicates if the part should be extracted.
bool	needsRecalc {}
	Indicates if the part needs update layout.
bool	useAsSmpInst {}
	Indicates if the part is used as a SmartMusic instrument.
int	smartMusicInst {}
	SmartMusic instrument ID (-1 if not used).
Cmper	defaultNameStaff {}
	If non-zero, this points to the Staff that has the default name (if unspecified by nameId.)
Cmper	defaultNameGroup {}
	If non-zero, this points to the details::StaffGroup that has the default name (if unspecified by nameId.)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "partDef"
	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 Finale "partDef".

Todo:

After identifying all possible fields, remove the override of PartDefinition::requireAllFields.

The cmper is the part definition ID, representing unique part definitions in the Finale document. This class is identified by the XML node name "partDef".

Member Function Documentation

calcSystemIuList()

Cmper musx::dom::others::PartDefinition::calcSystemIuList

(

Cmper

systemId

)

const

Return the InstrumentUsed cmper by this part for the specified system.

This function either returns the input systemId or the Special Part Extraction cmper.

Parameters

systemId

The staff system to find.

requireAllFields()

bool musx::dom::others::PartDefinition::requireAllFields ( ) const

inlineoverridevirtual

Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Some classes make it difficult to discover all the possible xml tags that might be used for all its options. An example is others::TextBlock. By overriding this function, a class can allow its members to be discovered as needed without causing error messages or throwing exceptions.

Remarks

This value only escapes errors on fields. Enum values must still have all values provided to avoid error messages or exceptions.

Reimplemented from musx::dom::Base.