Represents independent time and key signature overrides for a staff. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::IndependentStaffDetails:

Public Member Functions
	IndependentStaffDetails (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper inst, Cmper meas)
	Constructor function.

std::shared_ptr< TimeSignature >	createTimeSignature () const
	Create a shared pointer to an instance of the TimeSignature for this instance.

std::shared_ptr< TimeSignature >	createDisplayTimeSignature () const
	Create a shared pointer to an instance of the display TimeSignature for this measure and staff.

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

Public Attributes
std::shared_ptr< KeySignature >	keySig
	The key signature value if present. (xml tag is `<keySig>/<key>`)

bool	hasKey {}
	If true, this item contains an independent key signature.

Cmper	beats {}
	Time signature numerator or a Cmper to a composite record.

Cmper	divBeat {}
	Time signature denominator in Edu or a Cmper to a composite record.

Cmper	dispBeats {}
	Display time signature numerator or a Cmper to a composite record.

Cmper	dispDivBeat {}
	Display time signature denominator in Edu or a Cmper to a composite record.

bool	displayAltNumTsig {}
	If true, dispBeats is the Cmper of a others::TimeCompositeUpper record.

bool	displayAltDenTsig {}
	If true, dispDivBeat is the Cmper of a others::TimeCompositeLower record.

bool	altNumTsig {}
	If true, beats is the Cmper of a others::TimeCompositeUpper record.

bool	altDenTsig {}
	If true, divBeat is the Cmper of a others::TimeCompositeLower record.

bool	displayAbbrvTime {}
	If true, the display time signature is abbreviated.

bool	hasDispTime {}
	If true, the display time signature is present.

bool	hasTime {}
	If true, this item contains an independent time signature.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "floats"
	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.

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

Represents independent time and key signature overrides for a staff.

Cmper1 is the staff (inst) Cmper and Cmper2 is the measure Cmper. This class is identified by the XML node name "floats".

Constructor & Destructor Documentation

◆ IndependentStaffDetails()

musx::dom::details::IndependentStaffDetails::IndependentStaffDetails	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		Cmper	inst,
		Cmper	meas
	)

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 IndependentStaffDetails (probably always ShareMode::All).
inst	The staff ID for this IndependentStaffDetails.
meas	The measure ID for this IndependentStaffDetails.

Member Function Documentation

◆ createDisplayTimeSignature()

std::shared_ptr< TimeSignature > musx::dom::details::IndependentStaffDetails::createDisplayTimeSignature ( ) const

Create a shared pointer to an instance of the display TimeSignature for this measure and staff.

Returns: The display time signature if there is one, otherwise the actual time signature.

◆ integrityCheck()

void musx::dom::details::IndependentStaffDetails::integrityCheck ( )

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.

Exceptions

musx::dom::integrity_error if there is a problem.

Reimplemented from musx::dom::Base.

Public Member Functions

Static Public Member Functions

Public Attributes