musx::dom::others::ChordSuffixPlayback Class Reference

Represents a list of repeat ending numbers for a RepeatEndingStart instance. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::ChordSuffixPlayback:

Public Member Functions
	OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
Public Member Functions inherited from musx::dom::OthersArray< int16_t >
	OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
void	integrityCheck () override
	Override of Base::integrityCheck.
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.
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 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< ChordSuffixPlayback > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "chordSuffixPlay"
	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.
Public Attributes inherited from musx::dom::OthersArray< int16_t >
std::vector< int16_t >	values
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 and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Represents a list of repeat ending numbers for a RepeatEndingStart instance.

An array of semitone offsets that define the playback and voicing for the chord suffix. They are offsets from the root of the chord and may be negative or positive. Finale chord playback has no support for microtone scales, so all values in this table are strictly half-steps.

Zero-values (usually trailing at the end of the list) should be ignored.

The cmper is the cmper of the ChordSuffixElement array with the same cmper.

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