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.
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.
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)
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.

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

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

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::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.
	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.

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