musx::dom::CommonClassBase Class Reference

Base class for classes that are commonly used among others, details, entries, and/or texts. They can be constructed in atypical contexts, so their Part and Sharing info is not meaningful. More...

#include <BaseClasses.h>

Inheritance diagram for musx::dom::CommonClassBase:

Public Member Functions
	CommonClassBase (const DocumentWeakPtr &document)
	Constructs a CommonClassBase object.
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.
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
virtual Cmper	getPartId () const
	Gets the partId for this instance (or SCORE_PARTID for score)
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)
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.

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.

Detailed Description

Base class for classes that are commonly used among others, details, entries, and/or texts. They can be constructed in atypical contexts, so their Part and Sharing info is not meaningful.

Constructor & Destructor Documentation

CommonClassBase()

musx::dom::CommonClassBase::CommonClassBase ( const DocumentWeakPtr &  document )

inline

Constructs a CommonClassBase object.

Parameters

document

A weak pointer to the parent document.

Member Function Documentation

getPartId()

virtual Cmper musx::dom::Base::getPartId ( ) const

inlineprotectedvirtual

Gets the partId for this instance (or SCORE_PARTID for score)

Note

When you use get or getArray to retrieve an instance for a part, the value returned is either for that part or it is for the score. Therefore, this value is only reliable for determining the partId you are working on if the entity's share mode is ShareMode::None. Otherwise, it returns SCORE_PARTID for instances shared with the score.

Runtime-only classes (e.g., StaffComposite) override this function to return the requested part id.

Reimplemented from musx::dom::Base.