musx::dom::details::CenterShape Class Reference

Represents a center shape for a others::SmartShape that spans three or more measures. More...

#include <SmartShape.h>

Inheritance diagram for musx::dom::details::CenterShape:

Public Member Functions
	CenterShape (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper shapeNum, Cmper centerShapeNum)
	Constructor.
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::DetailsBase
	DetailsBase (const DetailsBase &)=default
	explicit default copy constructor
	DetailsBase (DetailsBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper1 () const
	Gets the cmper1 key value.
Cmper	getCmper2 () const
	Gets the cmper2 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 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< CenterShape > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
std::shared_ptr< smartshape::EndPointAdjustment >	startBreakAdj
	Adjustment at the start break (xml: <startBreakAdj>)
std::shared_ptr< smartshape::EndPointAdjustment >	endBreakAdj
	Adjustment at the end break (xml: <endBreakAdj>)
std::shared_ptr< smartshape::ControlPointAdjustment >	ctlPtAdj
	Manual adjustments made to this center shape.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "centerShape"
	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::DetailsBase
	DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
	Constructs a DetailsBase object.
DetailsBase &	operator= (const DetailsBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
DetailsBase &	operator= (DetailsBase &&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

Represents a center shape for a others::SmartShape that spans three or more measures.

A others::SmartShape instance controls the endpoint information for the start and end measures. It also controls the first and the final system breaks if the shape spans more than one system.

Every measure spanned by the shape in between the first and last measures is assigned its own center shape. These are only applicable if their measure is the first measure in a system that is not the first or last system. That means that for any center shape to be applicable, the shape must span at least three systems. However, the center shape records are created for every measure between the first and last, no matter how many or few systems the shape spans.

Cmper1 is the shape number. Cmper2 is the center shape number. (See others::SmartShapeMeasureAssign.) This class is identified by the XML node name "centerShape".

Constructor & Destructor Documentation

CenterShape()

musx::dom::details::CenterShape::CenterShape ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, Cmper  shapeNum, Cmper  centerShapeNum  )

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the associated document.
partId	The part that this is for.
shareMode	The sharing mode for this CenterShape.
shapeNum	The shape number from others::SmartShapeMeasureAssign.
centerShapeNum	The center shape number from others::SmartShapeMeasureAssign.

Member Function Documentation

integrityCheck()

void musx::dom::details::CenterShape::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

ptrToThis

This instance in a shared_ptr. (Avoids need for shared_from_this.)

Exceptions

musx::dom::integrity_error

if there is a problem.

Reimplemented from musx::dom::Base.