MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::others::RepeatBack Class Reference

Represents a repeat-backward marker with positioning and behavior properties. More...

#include <Others.h>

+ Inheritance diagram for musx::dom::others::RepeatBack:

Public Member Functions

 RepeatBack (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< IncigetInci () 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::PartDefinitiongetPartDefinition () const
 Gets the others::PartDefinition corresponding to getPartId.
 
ShareMode getShareMode () const
 Gets the sharing mode for this instance.
 
const SharedNodesgetUnlinkedNodes () 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< RepeatBack > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

int passNumber {}
 
int targetValue {}
 Absolute or relative measure number, depending on jumpAction. (xml tag is <target>)
 
Evpu leftHPos {}
 The horizontal position of the left bracket, relative to the default. (xml tag is <pos1>)
 
Evpu leftVPos {}
 The vertical position of the lower left bracket, relative to the default. (xml tag is <line1>)
 
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>)
 
RepeatActionType jumpAction {}
 The jump action for this repeat ending. The automatic jump is to the next ending. (xml tag is <action>)
 
RepeatTriggerType trigger {}
 The condition that triggers the jumpAction.
 
Cmper staffList {}
 If non-zero, specifies a staff list for which staves to show the ending.
 
Evpu rightHPos {}
 The horizontal position of the upper right bracket, relative to the default. (xml tag is <pos2>)
 
Evpu rightVPos {}
 The vertical position of the upper right bracket, relative to the default. (xml tag is <line2>)
 

Static Public Attributes

static constexpr std::string_view XmlNodeName = "repeatBack"
 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.
 
Baseoperator= (const Base &)
 assignment constructor: m_unlinkedNodes is intentionally omitted
 

Detailed Description

Represents a repeat-backward marker 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 "repeatBack".

Member Data Documentation

◆ passNumber

int musx::dom::others::RepeatBack::passNumber {}

Specifies the pass number for the trigger and depends on the value of trigger. (xml tag is <actuate>) If trigger is UntilPass, this specifies the number of times to play the section. If trigger is OnPass, this specifies the pass on which to jump.