musx::dom::others::PercussionNoteInfo Class Reference

Represents percussion notehead and staff position info for a given percussion note type. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::PercussionNoteInfo:

Public Member Functions
	PercussionNoteInfo (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
	Constructor function.
int	calcStaffReferencePosition () const
	Calculates the fixed staff position for this percussion note relative to a staff's reference line.
PercussionNoteTypeId	getBaseNoteTypeId () const
	Gets the base PercussionNoteTypeId.
unsigned	getNoteTypeOrderId () const
	Gets the orderId.
const percussion::PercussionNoteType &	getNoteType () const
	Gets a reference to the PercussionNoteType record for this note id.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.
Public Member Functions inherited from musx::dom::EnigmaBase
Cmper	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.
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 (const std::shared_ptr< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.
virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.
Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static const xml::XmlElementArray< PercussionNoteInfo > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
PercussionNoteTypeId	percNoteType {}
	The percussion note type ID. Compare this with the value in details::PercussionNoteCode.
int	staffPosition {}
char32_t	closedNotehead {}
	Codepoint for closed notehead (from percussion notehead font. See options::FontOptions::FontType::Percussion.)
char32_t	halfNotehead {}
	Codepoint for half notehead (from percussion notehead font. See options::FontOptions::FontType::Percussion.)
char32_t	wholeNotehead {}
	Codepoint for whole notehead (from percussion notehead font. See options::FontOptions::FontType::Percussion.)
char32_t	dwholeNotehead {}
	Codepoint for double whole notehead (from percussion notehead font. See options::FontOptions::FontType::Percussion.)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "percussionNoteInfo"
	The XML node name for this type.

Additional Inherited Members
Public Types inherited from musx::dom::EnigmaBase
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.
OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
Protected Member Functions inherited from musx::dom::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor
	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor
EnigmaBase &	operator= (const EnigmaBase &)
	no-op copy assignment operator allows subclasses to copy their values.
EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.
Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.
	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor
	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor
DocumentElement &	operator= (const DocumentElement &)
	no-op copy assignment operator allows subclasses to copy their values.
DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Represents percussion notehead and staff position info for a given percussion note type.

The cmper is the percussion map ID. Obtain this from Staff::percussionMapId. The inci identifies a specific note in the map. They are in no guaranteed order.

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

Member Function Documentation

getBaseNoteTypeId()

PercussionNoteTypeId musx::dom::others::PercussionNoteInfo::getBaseNoteTypeId ( ) const

inline

Gets the base PercussionNoteTypeId.

Returns

the base percussion note type id (used to look it up in the percussion::percussionNoteTypeMap.)

getNoteType()

const percussion::PercussionNoteType & musx::dom::others::PercussionNoteInfo::getNoteType

(

)

const

Gets a reference to the PercussionNoteType record for this note id.

Returns

Record from percussion::percussionNoteTypeMap.

getNoteTypeOrderId()

unsigned musx::dom::others::PercussionNoteInfo::getNoteTypeOrderId ( ) const

inline

Gets the orderId.

Returns

value used to distinguish different copies of the same note id.

Member Data Documentation

staffPosition

int musx::dom::others::PercussionNoteInfo::staffPosition {}

The fixed vertical staff position of the note. (xml node is <harmLev>.) This value is the staff position relative to the first ledger line below the staff. The logic behind this choice is that it is the middle-C position on a treble clef, but middle-C is not relevant to the note's pitch or value. Use calcStaffReferencePosition to get the staff position relative to the staff's reference line, which is often a more useful value.