Lists the order of flats by pitch class index (0..6 = C..B) in a custom key signature. Note that while flats are numbered from 1-7, this table is indexed 0-6. More...
#include <Others.h>
Inheritance diagram for musx::dom::others::AcciOrderFlats:
Public Member Functions | |
| OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
| Constructor function. | |
| Public Member Functions inherited from musx::dom::OthersArray< unsigned, 7 > | |
| 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. | |
| 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 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< AcciOrderFlats > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "acciOrderFlats" |
| 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< unsigned, 7 > | |
| std::vector< unsigned > | 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. | |
| 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
Lists the order of flats by pitch class index (0..6 = C..B) in a custom key signature. Note that while flats are numbered from 1-7, this table is indexed 0-6.
AcciOrderFlats is primarily useful with microtone systems that use standard key signatures. Typically linear modes in 12-EDO will not have this table, but larer EDOs will need to supply and AcciAmountFlats table, and this is here to match it.
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".
