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

Assigns a smart shape or center shape to a measure. More...

#include <SmartShape.h>

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

Public Member Functions

 SmartShapeMeasureAssign (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< 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< SmartShapeMeasureAssign > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

Cmper shapeNum {}
 The Cmper of the SmartShape that is being assigned.
 
Cmper centerShapeNum {}
 

Static Public Attributes

static constexpr std::string_view XmlNodeName = "smartShapeMeasMark"
 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

Assigns a smart shape or center shape to a measure.

Note that every smart shape has a measure assignment. This includes entry-assigned smart shapes that additionally have an entry assignment.

The cmper value is the measure Id.

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

Member Data Documentation

◆ centerShapeNum

Cmper musx::dom::others::SmartShapeMeasureAssign::centerShapeNum {}

If non-zero, the 2nd Cmper of the details::CenterShape. Zero if this measure starts or ends the smart shape.