musx::dom::details::Baseline Class Reference

Contains the baseline information for all baseline types. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::Baseline:

Public Member Functions
	Baseline (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff, std::optional< Inci > inci)
	Constructor function.
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 void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	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< Baseline > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	baselineDisplacement {}
std::optional< Cmper >	lyricNumber {}
	The 1-based text number of the lyric, if this is a lyrics baseline. Otherwise unused and should be std::nullopt.

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

Contains the baseline information for all baseline types.

cmper1 and cmper2 are used as follows.

cmper1	cmper2	Meaning	Related classes
0	0	Global baseline	Baseline*
0	staff	Staff baseline	Baseline*
system	staff	System & staff baseline (a specific staff within a system)	BaselineSystem*

Constructor & Destructor Documentation

Baseline()

musx::dom::details::Baseline::Baseline ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, Cmper  system, Cmper  staff, std::optional< Inci >  inci  )

inlineexplicit

Constructor function.

Parameters

document	A weak pointer to the associated document.
partId	The part that this is for (probably always 0).
shareMode	The sharing mode for this Baseline.
system	For system baselines, the system number. For global baselines, 0.
staff	For staff-level baselines, the staff number. For global baselines, 0.
inci	The 0-based inci. (For lyrics baselines only. Others use std::nullopt.)

Member Data Documentation

baselineDisplacement

Evpu musx::dom::details::Baseline::baselineDisplacement {}

The displacement of the baseline from its default position. (xml node is <basedisp>)

Note

The cumulative sum of all displacements is measured relative to value returned by others::Staff::calcBaselineZeroPosition. The full calculation is encapsulated in the others::Staff::calcBaselinePosition method.