musx::dom::others::StaffListRepeatPartsForced Class Reference

This class is used by repeat classes to define the forced staves for parts in a staff list. Repeats on these staves appear even if the staff has turned them off with Staff::hideRepeats or Staff::hideRptBars. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::StaffListRepeatPartsForced:

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

Additional Inherited Members
Public Types inherited from musx::dom::others::StaffList
enum class	FloatingValues : StaffCmper { TopStaff = -1 , BottomStaff = -2 }
	Defines special assignment values used for floating staff assignments. More...
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.
Public Member Functions inherited from musx::dom::others::StaffList
	OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
Public Member Functions inherited from musx::dom::OthersArray< StaffCmper >
	OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
void	integrityCheck (const std::shared_ptr< Base > &ptrToThis) override
	Override of Base::integrityCheck.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.
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	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.
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 inherited from musx::dom::others::StaffList
static const xml::XmlElementArray< StaffList > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.
Public Attributes inherited from musx::dom::OthersArray< StaffCmper >
std::vector< StaffCmper >	values
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.
OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
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

This class is used by repeat classes to define the forced staves for parts in a staff list. Repeats on these staves appear even if the staff has turned them off with Staff::hideRepeats or Staff::hideRptBars.

The Cmper is the value of the staff list created in the repeat or text repeat dialog. It ties all components of the staff list together.