Represents both sides of a beam extension. It is attached to the first entry in the beam. Which stem direction this instance controls is determined by the subclass that inherits this class as a base. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::BeamExtension:

Public Member Functions
	BeamExtension (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
	Constructor.

Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the `entnum` key value.

Public Member Functions inherited from musx::dom::DetailsBase
Cmper	getCmper1 () const
	Gets the `cmper1` key value.

Cmper	getCmper2 () const
	Gets the `cmper2` 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.

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< BeamExtension > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	leftOffset {}
	Left extension offset. (xml node is `<x3Disp>`)

Evpu	rightOffset {}
	Right extension offset. (xml node is `<x4Disp>`)

unsigned	mask {}

bool	extBeyond8th {}

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::EntryDetailsBase
	EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
	Constructs a EntryDetailsBase object.

Protected Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
	Constructs a DetailsBase 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

Represents both sides of a beam extension. It is attached to the first entry in the beam. Which stem direction this instance controls is determined by the subclass that inherits this class as a base.

Constructor & Destructor Documentation

◆ BeamExtension()

musx::dom::details::BeamExtension::BeamExtension	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		EntryNumber	entnum
	)

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the associated document.
partId	The part this is for.
shareMode	The sharing mode.
entnum	The entry number of the first entry in the beam this extension applies to.

Member Data Documentation

◆ extBeyond8th

bool musx::dom::details::BeamExtension::extBeyond8th {}

Legacy flag. Original versions of Finale could either extend only the 8th beam or extend a selection of beams. In musx files (Finale 2014+) this boolean has never been observed to be false. Instead, the mask appears always to be used to determine the beams to be extended. However, if a false value were encountered, it would mean only the 8th beam is extended.

◆ mask

unsigned musx::dom::details::BeamExtension::mask {}

Composite mask of beams to extend, derived from <do8th> through <do4096th> tags. A value of 512 is 8th, 256 is 16th, 128 is 32nd, etc. These correspond to the values in NoteType.

Public Member Functions

Static Public Member Functions