musx::dom::others::MusicRange Class Reference

Represents a range of music using measure and EDUs. More...

#include <CommonClasses.h>

Inheritance diagram for musx::dom::others::MusicRange:

Public Member Functions
	MusicRange (const DocumentWeakPtr &document, Cmper partId=SCORE_PARTID, ShareMode shareMode=ShareMode::All, Cmper cmper=0, std::optional< Inci > inci=std::nullopt)
	Constructs a MusicRange object.
bool	contains (MeasCmper measId, Edu eduPosition) const
	Returns true of the given metric location is contained in this MusicRange instance.
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 void	integrityCheck ()
	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.

Static Public Member Functions
static const xml::XmlElementArray< MusicRange > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
MeasCmper	startMeas {}
	Starting measure in the range.
Edu	startEdu {}
	Starting EDU (Elapsed Durational Unit) in the range.
MeasCmper	endMeas {}
	Ending measure in the range.
Edu	endEdu {}
	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::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

Represents a range of music using measure and EDUs.

This class is used to specify start and end points in a musical range using measures and EDUs.

Constructor & Destructor Documentation

MusicRange()

musx::dom::others::MusicRange::MusicRange ( const DocumentWeakPtr &  document, Cmper  partId = SCORE_PARTID, ShareMode  shareMode = ShareMode::All, Cmper  cmper = 0, std::optional< Inci >  inci = std::nullopt  )

inlineexplicit

Constructs a MusicRange object.

Parameters

document	Shared pointer to the document.
partId	The part ID if this range is unlinked, otherwise 0.
shareMode	The share mode if this range is unlinked.
cmper	Comperator parameter. This value is zero for ranges taken from others::InstrumentUsed.
inci	incident value, for subclasses that have them.

Member Function Documentation

contains()

bool musx::dom::others::MusicRange::contains ( MeasCmper  measId, Edu  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.