musx::dom::Document Class Reference

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.
constexpr Cmper	calcScrollViewCmper (Cmper partId) const noexcept
	Returns the Scroll View Cmper for the given partId.
MusxInstanceList< others::StaffUsed >	getScrollViewStaves (Cmper partId) const
	Returns the scroll view staves for the given partId.
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.
MusicRange	calcEntireDocument () const
	Calcuate a MusicRange instance for the entire document.
bool	iterateEntries (Cmper partId, std::function< bool(const EntryInfoPtr &)> iterator) const
	Iterate all entries in the document by staff and then measure. This function wraps MusxInstanceList<others::StaffUsed>::iterateEntries.

Friends
class	musx::factory::DocumentFactory

Detailed Description

Represents a document object that encapsulates the entire EnigmaXML structure.

Member Function Documentation

calcHasVaryingSystemStaves()

bool musx::dom::Document::calcHasVaryingSystemStaves

(

Cmper

forPartId

)

const

Calculate if the current score/part has staves that differ from system to system.

Parameters

forPartId

The linked score or part ID to check.

calcScrollViewCmper()

constexpr Cmper musx::dom::Document::calcScrollViewCmper ( Cmper  partId ) const

inlineconstexprnoexcept

Returns the Scroll View Cmper for the given partId.

Parameters

partId

The linked part to check.

calculatePageFromMeasure()

MusxInstance< others::Page > musx::dom::Document::calculatePageFromMeasure	(	Cmper	partId,
		MeasCmper	measureId
	)		const

Searches pages to find the page that contains the measure.

Parameters

partId	the linked part to search
measureId	the measure to find

calculateSystemFromMeasure()

MusxInstance< others::StaffSystem > musx::dom::Document::calculateSystemFromMeasure	(	Cmper	partId,
		MeasCmper	measureId
	)		const

Searches systems to find the page that contains the measure.

Parameters

partId	the linked part to search
measureId	the measure to find

createInstrumentMap()

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:

1. Defined multi-staff instruments (via multiStaffInstId).
2. Visually bracketed staves with matching instrument UUIDs.
3. Remaining single staves as individual instruments.

This is especially important for supporting legacy .musx files created before multi-staff instruments were defined explicitly.

Parameters

forPartId

The linked part for which to create the map.

getInstrumentForStaff()

const InstrumentInfo & musx::dom::Document::getInstrumentForStaff

(

StaffCmper

staffId

)

const

Get the instrument info for the given staffId.

Parameters

staffId

The staffId to find.

getScrollViewStaves()

MusxInstanceList< others::StaffUsed > musx::dom::Document::getScrollViewStaves

(

Cmper

partId

)

const

Returns the scroll view staves for the given partId.

Parameters

partId

The linked part to check.

iterateEntries()

bool musx::dom::Document::iterateEntries	(	Cmper	partId,
		std::function< bool(const EntryInfoPtr &)>	iterator
	)		const

Iterate all entries in the document by staff and then measure. This function wraps MusxInstanceList<others::StaffUsed>::iterateEntries.

Parameters

partId	The linked part id to iterate. (Use SCORE_PARTID to iterate the score.)
iterator	The callback function.

Returns

True if iteration completed. False if the iterator returned false and exited early.