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

Represents an assignment. More...

#include <Staff.h>

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

Public Member Functions

 StaffStyleAssign (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
 Constructor function.
 
MusxInstance< StaffStylegetStaffStyle () const
 Returns the StaffStyle instance for this assignment.
 
void integrityCheck (const std::shared_ptr< Base > &ptrToThis) override
 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.
 
- Public Member Functions inherited from musx::dom::others::MusicRange
 MusicRange (const DocumentWeakPtr &document, Cmper partId=SCORE_PARTID, ShareMode shareMode=ShareMode::All, Cmper cmper=0, std::optional< Inci > inci=std::nullopt)
 Constructs a MusicRange object.
 
bool contains (MeasCmper measId, Edu eduPosition) const
 Returns true of the given metric location is contained in this MusicRange instance.
 
std::optional< std::pair< MeasCmper, Edu > > nextLocation (const std::optional< StaffCmper > &forStaff=std::nullopt) const
 Returns the next metric location following the music range.
 
- 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< IncigetInci () 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 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 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< StaffStyleAssign > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 
- Static Public Member Functions inherited from musx::dom::others::MusicRange
static const xml::XmlElementArray< MusicRange > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

Cmper styleId {}
 The cmper of the assigned StaffStyle.
 
- Public Attributes inherited from musx::dom::others::MusicRange
MeasCmper startMeas {}
 Starting measure in the range.
 
Edu startEdu {}
 Starting EDU (Elapsed Durational Unit) in the range.
 
MeasCmper endMeas {}
 Ending measure in the range.
 
Edu endEdu {}
 Ending EDU (Elapsed Durational Unit) in the range.
 

Static Public Attributes

static constexpr std::string_view XmlNodeName = "staffStyleAssign"
 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.
 
OthersBaseoperator= (const OthersBase &other)
 Assignment operator delegates to base, preserving OthersBase state.
 
OthersBaseoperator= (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
 
Baseoperator= (const Base &)
 no-op copy assignment operator allows subclasses to copy their values.
 
Baseoperator= (Base &&) noexcept
 no-op move assignment operator allows subclasses to move their values.
 

Detailed Description

Represents an assignment.

The cmper is the staff ID. This class is identified by the XML node name "staffStyleAssign".

Member Function Documentation

◆ getStaffStyle()

MusxInstance< others::StaffStyle > musx::dom::others::StaffStyleAssign::getStaffStyle ( ) const

Returns the StaffStyle instance for this assignment.

Returns
Can return nullptr only in the case when there is an itegrity error
Exceptions
musx::dom::integrity_errorif compiled to throw integrity errors

◆ integrityCheck()

void musx::dom::others::StaffStyleAssign::integrityCheck ( const std::shared_ptr< Base > &  ptrToThis)
inlineoverridevirtual

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.

The default implementation should always be called inside an overridden implementation.

Parameters
ptrToThisThis instance in a shared_ptr. (Avoids need for shared_from_this.)
Exceptions
musx::dom::integrity_errorif there is a problem.

Reimplemented from musx::dom::Base.