musx::dom::MusicRange Class Reference

Utility class that represents of a range of musical time. More...

#include <CommonClasses.h>

Inheritance diagram for musx::dom::MusicRange:

Public Member Functions
	MusicRange (const DocumentWeakPtr &document, MeasCmper startMeasId, util::Fraction startPos, MeasCmper endMeasId, util::Fraction endPos)
	Constructs a MusicRange object.
bool	contains (MeasCmper measId, util::Fraction eduPosition) const
	Returns true of the given metric location is contained in this MusicRange instance.
bool	contains (const EntryInfoPtr &entryInfo) const
	Returns true if the metric location of the specified entry is contained in this MusicRange instance.
std::optional< std::pair< MeasCmper, Edu > >	nextLocation (const std::optional< StaffCmper > &forStaff=std::nullopt) const
	Returns the next metric location following the music range.
Public Member Functions inherited from musx::dom::CommonClassBase
	CommonClassBase (const DocumentWeakPtr &document)
	Constructs a CommonClassBase object.
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	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 void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes.
virtual bool	requireAllFields () const
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Public Attributes
MeasCmper	startMeasureId {}
	Starting measure in the range.
util::Fraction	startPosition {}
	Starting EDU (Elapsed Durational Unit) in the range.
MeasCmper	endMeasureId {}
	Ending measure in the range.
util::Fraction	endPosition {}
	Ending EDU (Elapsed Durational Unit) in the range.

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.
Protected Member Functions inherited from musx::dom::CommonClassBase
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)
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

Utility class that represents of a range of musical time.

This class is used to specify start and end points in a musical range using measures and util::Fraction values.

The class is agnostic as to whether the positions are global- or staff-position values. The consuming code makes this determination.

Constructor & Destructor Documentation

MusicRange()

musx::dom::MusicRange::MusicRange ( const DocumentWeakPtr &  document, MeasCmper  startMeasId, util::Fraction  startPos, MeasCmper  endMeasId, util::Fraction  endPos  )

inlineexplicit

Constructs a MusicRange object.

Parameters

document	Shared pointer to the document.
startMeasId	The start measure ID.
startPos	The start position. (Caller determines whether position is global- or staff-level.)
endMeasId	The end measure ID.
endPos	The end position. (Caller determines whether position is global- or staff-level.)

Member Function Documentation

contains() [1/2]

bool musx::dom::MusicRange::contains

(

const EntryInfoPtr &

entryInfo

)

const

Returns true if the metric location of the specified entry is contained in this MusicRange instance.

Parameters

entryInfo

The entry to check.

contains() [2/2]

bool musx::dom::MusicRange::contains ( MeasCmper  measId, util::Fraction  eduPosition  ) const

inline

Returns true of the given metric location is contained in this MusicRange instance.

Parameters

measId	The measure ID to search for.
eduPosition	The Edu position within the measure to search for.

nextLocation()

std::optional< std::pair< MeasCmper, Edu > > musx::dom::MusicRange::nextLocation

(

const std::optional< StaffCmper > &

forStaff = std::nullopt

)

const

Returns the next metric location following the music range.

Parameters

forStaff

If provided, calculates the next metric location using staff-level Edus.

Returns

An optional std::pair containing

• MeasCmper: the measure of the next location
• Edu: the location within the measure of the next location Return std::nullopt if the next location is past the end of the document, or other error.