musx::dom::others::RepeatIndividualPositioning Class Reference

Per-instance positioning overrides for repeat elements. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::RepeatIndividualPositioning:

Public Member Functions
	RepeatIndividualPositioning (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
	Constructs a RepeatIndividualPositioning object.
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 void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	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< RepeatIndividualPositioning > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
StaffCmper	staffId {}
	Staff for this individual positioning. (xml tag is <instno>)
MeasCmper	measureId {}
	Measure for text repeats, otherwise zero. (xml tag is <id>)
bool	hidden {}
	Overrides the value in the main record. (Ignored for RepeatEndingTextIndividualPositioning)
Evpu	x1add {}
	Left/start X offset in Evpu.
Evpu	y1add {}
	Left/start Y offset in Evpu.
Evpu	x2add {}
	Right/end X offset in Evpu. (Always zero for RepeatEndingTextIndividualPositioning and TextRepeatIndividualPositioning.)
Evpu	y2add {}
	Right/end Y offset in Evpu. (Always zero for RepeatEndingTextIndividualPositioning and TextRepeatIndividualPositioning.)

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.
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

Per-instance positioning overrides for repeat elements.

This class captures individual offsets and visibility for repeat endings and repeat text that can be positioned per instance on a staff/system.

This is a base class, and the meaning of the cmper and inci varies according to the subclass.

Constructor & Destructor Documentation

RepeatIndividualPositioning()

musx::dom::others::RepeatIndividualPositioning::RepeatIndividualPositioning ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, Cmper  cmper, Inci  inci  )

inlineexplicit

Constructs a RepeatIndividualPositioning object.

Parameters

document	Shared pointer to the document.
partId	The part ID if this positioning is unlinked.
shareMode	The share mode if this positioning is unlinked.
cmper	Identifier for this record. (See subclasses.)
inci	The specific record with this cmper.