Base class to enforce polymorphism across all DOM classes. More...

#include <BaseClasses.h>

Inheritance diagram for musx::dom::Base:

Public Types
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
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.

Protected Member Functions
	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

Base class to enforce polymorphism across all DOM classes.

Member Enumeration Documentation

◆ ShareMode

enum class musx::dom::Base::ShareMode

strong

Describes how this instance is shared between part and score.

Enumerator
All	All parts and score always share (no "share" attribute). Default.
Partial	Part and score share some attributes and have their own unlinked versions of others. (attribute "share"="true")
None	Each part and score has its own version of the DOM class. (attribute "share"="false")

Constructor & Destructor Documentation

◆ Base()

musx::dom::Base::Base	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode
	)

inlineprotected

Constructs the base class and enforces the static constexpr XmlNodeName.

Parameters

document	A weak pointer to the parent document
partId	The part ID for this instance, or zero if for score.
shareMode	The ShareMode for this instance.

Member Function Documentation

◆ getDocument()

DocumentPtr musx::dom::Base::getDocument ( ) const

inline

Gets a reference to the Document.

Returns: A pointer to the Document instance.

◆ integrityCheck()

virtual void musx::dom::Base::integrityCheck ( )

inlinevirtual

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.

Exceptions

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

Reimplemented in musx::dom::others::RepeatEndingStart, musx::dom::OthersArray< ElementType, REQUIRED_SIZE >, musx::dom::OthersArray< int >, musx::dom::OthersArray< int, 7 >, musx::dom::OthersArray< int16_t >, musx::dom::OthersArray< unsigned, 7 >, musx::dom::OthersArray< unsigned, 8 >, musx::dom::KeySignature, musx::dom::details::GFrameHold, musx::dom::details::IndependentStaffDetails, musx::dom::details::SecondaryBeamBreak, musx::dom::details::StaffGroup, musx::dom::Entry, musx::dom::others::BeatChartElement, musx::dom::others::Frame, musx::dom::others::Measure, musx::dom::others::MeasureExprAssign, musx::dom::others::MultimeasureRest, musx::dom::others::MultiStaffInstrumentGroup, musx::dom::others::Staff, musx::dom::others::StaffStyle, musx::dom::others::StaffStyleAssign, musx::dom::others::SmartShape::TerminationSeg, musx::dom::others::SmartShape, and musx::dom::details::CenterShape.

◆ requireAllFields()

virtual bool musx::dom::Base::requireAllFields ( ) const

inlinevirtual

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.

Public Types

Public Member Functions

Protected Member Functions