musx::dom::others::SystemLock Class Reference

Locks a span of one or more measures so that they always appear in a StaffSystem together. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::SystemLock:

Public Member Functions
	SystemLock (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
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.
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< SystemLock > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
MeasCmper	endMeas {}

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "lockMeas"
	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

Locks a span of one or more measures so that they always appear in a StaffSystem together.

The cmper indicates the first measure of the locked system. The endMeas element specifies the first measure after the locked system.

The class is identified by the XML node name "lockMeas".

Member Data Documentation

endMeas

MeasCmper musx::dom::others::SystemLock::endMeas {}

The first measure after the locked system, or one measure past the end of document if this is the last system.