musx::dom::NoteDetailsBase Class Reference

Base class note details. Note details are entry details associated with a note ID. More...

#include <BaseClasses.h>

Inheritance diagram for musx::dom::NoteDetailsBase:

Public Member Functions
virtual NoteNumber	getNoteId () const =0
	Required virtual function that returns the note id.
Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the entnum key value.
Public Member Functions inherited from musx::dom::DetailsBase
Cmper	getCmper1 () const
	Gets the cmper1 key value.
Cmper	getCmper2 () const
	Gets the cmper2 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.

Protected Member Functions
	EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
	Constructs a EntryDetailsBase object.
Protected Member Functions inherited from musx::dom::EntryDetailsBase
	EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
	Constructs a EntryDetailsBase object.
Protected Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
	Constructs a DetailsBase 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

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 note details. Note details are entry details associated with a note ID.

Member Function Documentation

EntryDetailsBase()

musx::dom::EntryDetailsBase::EntryDetailsBase ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, EntryNumber  entnum, std::optional< Inci >  inci = std::nullopt  )

inlineprotected

Constructs a EntryDetailsBase object.

Parameters

document	A weak pointer to the parent document
partId	The part Id for this Detail, or zero if for score.
shareMode	Usually ShareMode::All. This parameter is used with linked parts data.
entnum	The EntryNumber key value.
inci	The array index (Inci).

getNoteId()

virtual NoteNumber musx::dom::NoteDetailsBase::getNoteId ( ) const

pure virtual

Required virtual function that returns the note id.

Implemented in musx::dom::details::CrossStaff, and musx::dom::details::TieAlterBase.