Maps the number of flats to a tonal center for a linear custom key. If there are zero flats or sharps, do not use this table. Use TonalCenterSharps for zero. If the key has flats, the number is returned as a negative number (-1..-7) from KeySignature::getAlteration. Use the absolute value of that number to index this table. More...
#include <Others.h>
Inheritance diagram for musx::dom::others::TonalCenterFlats:
Public Member Functions | |
| OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
| Constructor function. | |
| Public Member Functions inherited from musx::dom::OthersArray< unsigned, 8 > | |
| 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< TonalCenterFlats > & | xmlMappingArray () |
| Required for musx::factory::FieldPopulator. | |
Static Public Attributes | |
| static constexpr std::string_view | XmlNodeName = "fstKeyFlats" |
| 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, 8 > | |
| 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 and enforces the static constexpr XmlNodeName. | |
| Base & | operator= (const Base &) |
| assignment constructor: m_unlinkedNodes is intentionally omitted | |
Detailed Description
Maps the number of flats to a tonal center for a linear custom key. If there are zero flats or sharps, do not use this table. Use TonalCenterSharps for zero. If the key has flats, the number is returned as a negative number (-1..-7) from KeySignature::getAlteration. Use the absolute value of that number to index this table.
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 "fstKeyFlats".
