MUSX Document Model
|
Lists the order of sharps by pitch class index (0..6 = C..B) in a custom key signature. Note that while sharps are numbered from 1-7, this table is indexed 0-6. More...
#include <Others.h>
Public Member Functions | |
OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
Constructor function. | |
![]() | |
OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
Constructor function. | |
void | integrityCheck (const std::shared_ptr< Base > &ptrToThis) override |
Override of Base::integrityCheck. | |
![]() | |
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. | |
![]() | |
virtual | ~Base () noexcept(false)=default |
Virtual destructor for polymorphic behavior. | |
DocumentPtr | getDocument () const |
Gets a reference to the Document. | |
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 |
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< AcciOrderSharps > & | xmlMappingArray () |
Required for musx::factory::FieldPopulator. | |
Static Public Attributes | |
static constexpr std::string_view | XmlNodeName = "acciOrderSharps" |
The XML node name for this type. | |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
std::vector< unsigned > | values |
![]() | |
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. | |
![]() | |
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. | |
Lists the order of sharps by pitch class index (0..6 = C..B) in a custom key signature. Note that while sharps are numbered from 1-7, this table is indexed 0-6.
AcciOrderSharps is required for non-linear key signatures. It specifies the order of pitch class indices for the corresponding sharps and flats in AcciAmountSharps, which can be mixed in any order. The first zero value in the AcciAmountSharps table terminates the sequence of sharps or flats, and the rest of the values here are meaningless.
AcciOrderSharps is also useful with microtone systems that use standard key signatures. Typically linear modes in 12-EDO will not have this table, but larger EDOs will need to supply an AcciAmountSharps table, and this should have values that correspond.
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".