Assigns a TextExpressionDef or ShapeExpressionDef to a measure. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::MeasureExprAssign:

Public Member Functions
	MeasureExprAssign (const DocumentWeakPtr &document, Cmper ID, ShareMode shareMode, Cmper cmper, Inci inci)
	Constructor function.

std::shared_ptr< TextExpressionDef >	getTextExpression () const
	Gets the assigned text expression.

std::shared_ptr< ShapeExpressionDef >	getShapeExpression () const
	Gets the assigned shape expression.

void	integrityCheck () override
	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.

bool	requireAllFields () const override

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.

virtual Cmper	getPartId () const
	Gets the partId for this instance (or SCORE_PARTID for score)

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.

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

Public Attributes
Cmper	textExprId {}
	The Cmper of a text expression (xml node is `<textExprID>`)

Cmper	shapeExprId {}
	The Cmper of a shape expression (xml node is `<shapeExprID>`)

Evpu	horzEvpuOff {}
	Horizontal Evpu offset from the default position.

Edu	eduPosition {}
	Horizontal Edu position (xml node is `<horzEduOff>`)

Evpu	vertEvpuOff {}
	Vertical Evpu offset from the default position (xml node is `<vertOff>`)

InstCmper	staffAssign {}
	The staff to which this expression is assigned, or -1 if it uses staffList.

int	layer {}
	The 1-based layer number to which this expression is assigned. (0 means all)

bool	dontScaleWithEntry {}
	Inverse of "Scale Expression with Attached Note".

Cmper	staffGroup {}
	Not sure what this is used for, but it seems to be a details::StaffGroup cmper.

Cmper	staffList {}
	The cmper of the staff list to use if staffAssign is negative.

bool	hidden {}
	True if the dynamic is hidden.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "measExprAssign"
	The XML node name for this type.

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.

	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

Assigns a TextExpressionDef or ShapeExpressionDef to a measure.

Only one of textExprId or shapeExprId is non-zero.

The Cmper for a MeasureExprAssign is the cmper of the Measure to which it is attached.

Member Function Documentation

◆ getShapeExpression()

std::shared_ptr< others::ShapeExpressionDef > musx::dom::others::MeasureExprAssign::getShapeExpression ( ) const

Gets the assigned shape expression.

Returns: The shape expression or nullptr if this assignment is for a text expression or shapeExprId not found.

◆ getTextExpression()

std::shared_ptr< others::TextExpressionDef > musx::dom::others::MeasureExprAssign::getTextExpression ( ) const

Gets the assigned text expression.

Returns: The text expression or nullptr if this assignment is for a shape expression or textExprId not found.

◆ integrityCheck()

void musx::dom::others::MeasureExprAssign::integrityCheck ( )

inlineoverridevirtual

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.

The default implementation should always be called inside an overridden implementation.

Exceptions

musx::dom::integrity_error if there is a problem.

Reimplemented from musx::dom::Base.

◆ requireAllFields()

bool musx::dom::others::MeasureExprAssign::requireAllFields ( ) const

inlineoverridevirtual

Todo:: : remove this override after identifying all fields.

Reimplemented from musx::dom::Base.

Public Member Functions

Static Public Member Functions

Public Attributes