MUSX Document Model
|
Represents a document object that encapsulates the entire EnigmaXML structure. More...
#include <Document.h>
Public Member Functions | |
HeaderPtr & | getHeader () |
Retrieves the header. | |
const HeaderPtr & | getHeader () const |
Retrieves the const header. | |
OptionsPoolPtr & | getOptions () |
Retrieves the options pool. | |
const OptionsPoolPtr & | getOptions () const |
Retrieves the const options pool. | |
OthersPoolPtr & | getOthers () |
Retrieves the others pool. | |
const OthersPoolPtr & | getOthers () const |
Retrieves the const others pool. | |
DetailsPoolPtr & | getDetails () |
Retrieves the details pool. | |
const DetailsPoolPtr & | getDetails () const |
Retrieves the const others pool. | |
EntryPoolPtr & | getEntries () |
Retrieves the entry pool. | |
const EntryPoolPtr & | getEntries () const |
Retrieves the entry others pool. | |
TextsPoolPtr & | getTexts () |
Retrieves the texts pool. | |
const TextsPoolPtr & | getTexts () const |
Retrieves the const texts pool. | |
MusxInstance< others::Page > | calculatePageFromMeasure (Cmper partId, MeasCmper measureId) const |
Searches pages to find the page that contains the measure. | |
MusxInstance< others::StaffSystem > | calculateSystemFromMeasure (Cmper partId, MeasCmper measureId) const |
Searches systems to find the page that contains the measure. | |
int | getMaxBlankPages () const |
Returns the maximum number of blank pages in any part. This is calculated by factory::DocumentFactory::create. | |
const InstrumentMap & | getInstruments () const |
Returns the instrument map for this document. It is computed by the factory. | |
const InstrumentInfo & | getInstrumentForStaff (StaffCmper staffId) const |
Get the instrument info for the given staffId. | |
InstrumentMap | createInstrumentMap (Cmper forPartId) const |
Builds an instrument map for the specified linked part ID. | |
bool | calcHasVaryingSystemStaves (Cmper forPartId) const |
Calculate if the current score/part has staves that differ from system to system. | |
Friends | |
class | musx::factory::DocumentFactory |
Represents a document object that encapsulates the entire EnigmaXML structure.
bool musx::dom::Document::calcHasVaryingSystemStaves | ( | Cmper | forPartId | ) | const |
Calculate if the current score/part has staves that differ from system to system.
forPartId | The linked score or part ID to check. |
MusxInstance< others::Page > musx::dom::Document::calculatePageFromMeasure | ( | Cmper | partId, |
MeasCmper | measureId | ||
) | const |
Searches pages to find the page that contains the measure.
partId | the linked part to search |
measureId | the measure to find |
MusxInstance< others::StaffSystem > musx::dom::Document::calculateSystemFromMeasure | ( | Cmper | partId, |
MeasCmper | measureId | ||
) | const |
Searches systems to find the page that contains the measure.
partId | the linked part to search |
measureId | the measure to find |
InstrumentMap musx::dom::Document::createInstrumentMap | ( | Cmper | forPartId | ) | const |
Builds an instrument map for the specified linked part ID.
This routine detects instrument groupings in three stages:
This is especially important for supporting legacy .musx files created before multi-staff instruments were defined explicitly.
forPartId | The linked part for which to create the map. |
const InstrumentInfo & musx::dom::Document::getInstrumentForStaff | ( | StaffCmper | staffId | ) | const |
Get the instrument info for the given staffId.
staffId | The staffId to find. |