musx::dom::details::SecondaryBeamBreak Class Reference

Specifies which secondary beams break and restart on the associated entry. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::SecondaryBeamBreak:

Public Member Functions
	SecondaryBeamBreak (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
	Constructor function.
BeamNumber	calcLowestBreak () const
	Calculates the lowest (largest note-value) beam specified for a secondary beam break.
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.
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.
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 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< SecondaryBeamBreak > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
unsigned	mask {}
	Composite mask of beam breaks, derived from <do16th> through <do4096th> tags.
bool	breakThrough {}
	True if the beam should be broken through to the largest specified beam value.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "secBeamBreak"
	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::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 and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Specifies which secondary beams break and restart on the associated entry.

This class is identified by the XML node name "secBeamBreak".

Member Function Documentation

calcLowestBreak()

BeamNumber musx::dom::details::SecondaryBeamBreak::calcLowestBreak ( ) const

inline

Calculates the lowest (largest note-value) beam specified for a secondary beam break.

This function ignores breakThrough, since it is nearly meaningless even in Finale.

Returns

A BeamNumber value (minimum 2) for the lowest beam number that should be broken. Returns 0 if the mask is invalid.

integrityCheck()

void musx::dom::details::SecondaryBeamBreak::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.