Lists the aleration values of each nth sharp in a custom key signature. Normally these values are all set to the number of EDO divisions in a chromatic half-step. More...
#include <Others.h>
Inheritance diagram for musx::dom::others::AcciAmountSharps:
Public Member Functions | |
| OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
| Constructor function. | |
| Public Member Functions inherited from musx::dom::OthersArray< int, 7 > | |
| OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
| Constructor function. | |
| bool | containsValue (const int &value) const noexcept |
| Returns true if the array contains the specified value. | |
| void | integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis) override |
| Override of EnigmaBase::integrityCheck. | |
| 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 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< AcciAmountSharps > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "acciAmountSharps" |
| 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. | |
| Public Attributes inherited from musx::dom::OthersArray< int, 7 > | |
| std::vector< int > | 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. | |
| 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
Lists the aleration values of each nth sharp in a custom key signature. Normally these values are all set to the number of EDO divisions in a chromatic half-step.
Note that while flats are numbered from 1-7, this table is indexed 0-6.
AcciAmountSharps is required for non-linear key signatures. It specifies whether a slot is a sharp or a flat with a positive or negative value. The first zero value in the table terminates the sequence of accidentals in the key signature.
AcciAmountSharps is also useful with microtone systems that use standard key signatures. Typically linear modes in 12-EDO will not have this table, but EDOs larger than 19-EDO may need to specify acci alteration amounts with magnitude larger than 1 (equal to the number of EDO divisions in a chromatic half-step.)
The cmper is the value returned by KeySignature::getKeyMode. The built-in major and minor cmpers (0 and 1) ignore this table, and it should not be present for those values. (However, with Finale anything is possible.)
This class is identified by the XML node name "acciAmountFlats".
