musx::dom::others::TextRepeatAssign Class Reference

Represents a text repeat assignment with positioning and behavior properties. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::TextRepeatAssign:

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

Public Attributes
Evpu	horzPos {}
	The horizontal offset from default of the text repeat marker.
int	passNumber {}
	Play Section N Times, Jump on Pass, Stop on Pass value, depending on jumpAction and trigger. (xml tag is <actuate>)
int	targetValue {}
	Measure number, TextRepeatDef ID, or offset, depending on jumpAction. (xml tag is <target>)
Cmper	textRepeatId {}
	The Cmper of the assigned TextRepeatDef. (xml tag is <repnum>)
Evpu	vertPos {}
	The vertical offset from default of the text repeat marker.
bool	individualPlacement {}
	"Allow Individual Edits Per Staff" (xml tag is <indivPlac>)
bool	topStaffOnly {}
	"Show On: Top Staff Only"
bool	resetOnAction {}
	"Reset on Repeat Action" (xml tag is <clrOnChange>)
bool	jumpOnMultiplePasses {}
	If true, use TextRepeatDef::passList to get the passes and ignore passNumber. (xml tag is <multiActuate>)
RepeatActionType	jumpAction {}
	The jump action for this repeat assignment. (xml tag is <action>)
bool	autoUpdate {}
	"Auto-Update Target"
RepeatTriggerType	trigger {}
	The condition that triggers the jumpAction.
bool	jumpIfIgnoring {}
	"Jump if Ignoring Repeats" (xml tag is <jmpIgnore>)
Cmper	staffList {}
	If non-zero, specifies a staff list for which staves to show the ending.

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

Detailed Description

Represents a text repeat assignment with positioning and behavior properties.

The cmper is the cmper of the Measure that has this item.

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