musx::dom::details::BaselineLyricsSection Class Reference

Contains the baseline offsets for lyrics chorus records. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::BaselineLyricsSection:

Public Types
using	TextType = texts::LyricsSection
	The text type for this item.
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.

Public Member Functions
	Baseline (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff, std::optional< Inci > inci=std::nullopt)
	Constructor function.
Public Member Functions inherited from musx::dom::details::Baseline
	Baseline (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff, std::optional< Inci > inci=std::nullopt)
	Constructor function.
Public Member Functions inherited from musx::dom::DetailsBase
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).
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::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.
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 ()
	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 Attributes
static constexpr std::string_view	XmlNodeName = "baselinesLyricsSection"
	The XML node name for this type.

Additional Inherited Members
Static Public Member Functions inherited from musx::dom::details::Baseline
static const xml::XmlElementArray< Baseline > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.
Public Attributes inherited from musx::dom::details::Baseline
Evpu	baselineDisplacement {}
	the displacment of the baseline from default position. (xml node is <basedisp>)
Cmper	lyricNumber {}
	the text number of the lyric, if this is a lyrics baseline. Otherwise unused and should be zero.
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.
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.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Contains the baseline offsets for lyrics chorus records.

Member Function Documentation

Baseline()

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

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, if needed. (Lyrics baselines have multiple instances per lyricNumber.)