musx::dom::others::StaffComposite Class Reference

Represents a composite of an underlying Staff instance with any applicable StaffStyle instances applied. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::StaffComposite:

Public Member Functions
Cmper	getPartId () const final override
	Overrides Base function to return the requested part id instead of the Staff's source part id (which is always the score)
Public Member Functions inherited from musx::dom::others::StaffStyle
	StaffStyle (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
bool	requireAllFields () const override
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
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::others::Staff
	Staff (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
std::string	getFullName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Returns the full staff name without Enigma tags.
std::string	getAbbreviatedName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Returns the abbreviated staff name without Enigma tags.
std::shared_ptr< MultiStaffInstrumentGroup >	getMultiStaffInstGroup () const
	Returns the MultiStaffInstrumentGroup for this staff if it is part of one. Otherwise nullptr.
std::string	getFullInstrumentName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii, bool preferStaffName=false) const
	Returns the full instrument name for this staff without Enigma tags and with autonumbering (if any)
std::string	getAbbreviatedInstrumentName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii, bool preferStaffName=false) const
	Returns the abbreviated instrument name for this staff without Enigma tags and with autonumbering (if any)
std::shared_ptr< const NamePositioning >	getFullNamePosition () const
	Returns the full name positioning in effect for this staff instance.
std::shared_ptr< const NamePositioning >	getAbbreviatedNamePosition () const
	Returns the abbreviated name positioning in effect for this staff instance.
bool	showNamesForPart (Cmper partId) const
	Returns if names should be shown for the specified part.
std::string	addAutoNumbering (const std::string &plainName) const
	Add auto numbering as a prefix or suffix, if needed.
ClefIndex	calcClefIndexAt (MeasCmper measureId, Edu position, bool forWrittenPitch=false) const
	Returns the clef in this staff at the specified location.
ClefIndex	calcFirstClefIndex (bool forWrittenPitch=false) const
	Returns the first clef in this staff.
int	calcMiddleStaffPosition () const
	Returns the middle staff position. For staves with even numbers of lines, it is the middle space.
int	calcToplinePosition () const
	Returns the position of the top staff line, relative to the reference line.
bool	hasInstrumentAssigned () const
	Return true if this staff has an instrument assigned.
std::vector< std::shared_ptr< PartDefinition > >	getContainingParts () const
	Gets a list of all parts that contain this staff, including the score.
std::shared_ptr< PartDefinition >	firstFirstContainingPart () const
	Finds the first part that contains this staff, not including the score.
Public Member Functions inherited from musx::dom::OthersBase
Cmper	getCmper () const
	Gets the cmper 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.
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.

Static Public Member Functions
static std::shared_ptr< StaffComposite >	createCurrent (const DocumentPtr &document, Cmper partId, InstCmper staffId, MeasCmper measId, Edu eduPosition)
	Calculates the current staff at the specified metric position by applying all relevant staff styles,.
Static Public Member Functions inherited from musx::dom::others::StaffStyle
static std::vector< std::shared_ptr< StaffStyle > >	findAllOverlappingStyles (const DocumentPtr &document, Cmper partId, InstCmper staffId, MeasCmper measId, Edu eduPosition)
	Finds a subset from all StaffStyle instances that overlap with the specified metric position on a given staff in a give linked part or score.
static const xml::XmlElementArray< StaffStyle > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.
Static Public Member Functions inherited from musx::dom::others::Staff
static void	calcAllAutoNumberValues (const DocumentPtr &document)
	Get the auto-numbering value for this staff, if applicable.
template<typename SubType >
static void	calcAllRuntimeValues (const DocumentPtr &document)
	Populate runtime values for all staves or staffstyles, such as percussion map Id if any.
static ClefIndex	calcFirstClefIndex (const DocumentPtr &document, Cmper partId, InstCmper staffCmper)
	Returns the first clef in the specified staff in the document.
static const xml::XmlElementArray< Staff > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Additional Inherited Members
Public Types inherited from musx::dom::others::Staff
enum class	AutoNumberingStyle {   ArabicSuffix , RomanSuffix , OrdinalPrefix , AlphaSuffix ,   ArabicPrefix }
	Enum for auto-numbering style. Auto-numbering is based on instUuid. More...
enum class	StemDirection { Default , AlwaysUp , AlwaysDown }
	Enum for staff-level stem direction override. More...
enum class	NotationStyle { Standard , Percussion , Tablature }
	Enum for notation style.
enum class	HideMode { None , Cutaway , ScoreParts , Score }
	Enum for hide mode. More...
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 Attributes inherited from musx::dom::others::StaffStyle
std::string	styleName
	name of staff style
bool	addToMenu
	add this staff style to the context menu for staff styles
std::shared_ptr< Masks >	masks
Public Attributes inherited from musx::dom::others::Staff
NotationStyle	notationStyle {}
	Standard, percussion, or tablature.
std::shared_ptr< FontInfo >	noteFont
	The custom font to use for noteheads. Guaranteed non-null by integrityCheck if useNoteFont is true.
bool	useNoteFont {}
	Indicates if noteFont should be used.
ClefIndex	defaultClef {}
	Index of default clef for the staff.
ClefIndex	transposedClef {}
	Index of transposed clef for the staff. Only used if Transposition::setToClef is true.
std::optional< int >	staffLines {}
	Number of lines in the staff (if no custom staff)
std::optional< std::vector< int > >	customStaff
	A list of stafflines from 0..26 where a standard 5-line staff is values 11, 12, 13, 14, 15.
Evpu	lineSpace {}
	Distance between staff lines.
std::string	instUuid
	Unique identifier for the type of instrument.
bool	floatKeys {}
	"Independent Key Signature"
bool	floatTime {}
	"Independent Time Signature"
bool	blineBreak {}
	"Break Barlines Between Staves"
bool	rbarBreak {}
	"Break Repeat Barlines Between Staves"
bool	hasStyles {}
	Indicates that this staff has staff style assignments.
bool	showNameInParts {}
	"Display Staff Name in Parts" (xml node is <showNameParts>)
std::shared_ptr< Transposition >	transposition
	Transposition details, if non-null.
bool	hideNameInScore {}
	Inverse of "Display Staff Name in Score" (xml node is <hideStfNameInScore>)
Evpu	botBarlineOffset {}
	Offset for the bottom barline.
bool	hideRepeatBottomDot {}
	Inverse of "Bottom Repeat Dot" in Staff Setup dialog.
bool	flatBeams {}
	"Flat Beams"
bool	hideFretboards {}
	Inverse of "Display Fretboards".
bool	blankMeasure {}
	Inverse of "Display Rests in Empty Measures".
bool	hideRepeatTopDot {}
	Inverse of "Top Repeat Dot" in Staff Setup dialog.
bool	hideLyrics {}
	Inverse of "Display Lyrics".
bool	noOptimize {}
	Inverse of "Allow Hiding When Empty".
Evpu	topBarlineOffset {}
	Offset for the top barline.
bool	hideMeasNums {}
	Inverse of "Display Measure Numbers".
bool	hideRepeats {}
	Inverse of "Display Endings and Text Repeats".
bool	hideBarlines {}
	Inverse of "Display Barlines".
bool	hideRptBars {}
	Inverse of "Display Repeat Bars".
bool	hideKeySigs {}
	Inverse of "Display Key Signatures".
bool	hideTimeSigs {}
	Inverse of "Display Time Signatures in Score".
bool	hideClefs {}
	Inverse of "Display Clefs".
bool	hideStaffLines {}
	Inverse of "Display Staff Lines".
bool	hideChords {}
	Inverse of "Display Chords".
bool	noKey {}
	"Ignore Key Signatures"
Evpu	dwRestOffset {}
	Offset for downstem rests.
Evpu	wRestOffset {}
	Offset for whole rests.
Evpu	hRestOffset {}
	Offset for half rests.
Evpu	otherRestOffset {}
	Offset for other rests.
bool	hideRests {}
	Inverse of "Display Rests".
bool	hideTies {}
	Inverse of "Display Ties".
bool	hideDots {}
	Inverse of "Display Augmentation Dots".
int	stemReversal {}
	Stem reversal value.
Cmper	fullNameTextId {}
	Full name TextBlock ID. (xml node is <fullName>)
Cmper	abbrvNameTextId {}
	Abbreviated name TextBlock ID. (xml node is <abbrvName>)
Evpu	botRepeatDotOff {}
	Offset for bottom repeat dots.
Evpu	topRepeatDotOff {}
	Offset for top repeat dots.
Evpu	vertTabNumOff {}
	Vertical offset for tab number.
bool	hideStems {}
	Inverse of "Display Stems".
StemDirection	stemDirection {}
	stem direction for staff (xml node is <stemDir>)
bool	hideBeams {}
	Inverse of "Show Beams".
HideMode	hideMode {}
	"Force Hide Staff" option
bool	redisplayLayerAccis {}
	"Redisplay Accidentals in Other Layers Within Measures"
bool	hideTimeSigsInParts {}
	Inverse of "Display Time Signatures in Parts".
AutoNumberingStyle	autoNumbering {}
	Autonumbering style if useAutoNumbering is true. (xml node is <autoNum>)
bool	useAutoNumbering {}
	Whether names should be auto-numbered. (xml node is <useAutoNum>)
bool	hideKeySigsShowAccis {}
	"Hide Key Signature and Show Accidentals" transposition option.
Cmper	fullNamePosId {}
bool	fullNamePosFromStyle {}
Cmper	abrvNamePosId {}
bool	abrvNamePosFromStyle {}
Cmper	multiStaffInstId {}
	It is set by the factory with the Resolver function for MultiStaffInstrumentGroup.
std::optional< int >	autoNumberValue
	Calculated autonumbering value. It is computed by calcAllAutoNumberValues.
std::optional< Cmper >	percussionMapId
	Calculated percussion map Id for a percussion staff. (Populated by in calcAllRuntimeValues.)
Static Public Attributes inherited from musx::dom::others::StaffStyle
static constexpr std::string_view	XmlNodeName = "staffStyle"
	The XML node name for this type.
Static Public Attributes inherited from musx::dom::others::Staff
static constexpr std::string_view	XmlNodeName = "staffSpec"
	The XML node name for this type.
Protected Member Functions inherited from musx::dom::others::StaffStyle
	StaffStyle (const std::shared_ptr< Staff > &staff)
	protected constructor for StaffComposite
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.
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 composite of an underlying Staff instance with any applicable StaffStyle instances applied.

Instances of StaffComposite are not part of the document structure and cannot be created directly. Use createCurrent to create an instance.

Member Function Documentation

createCurrent()

std::shared_ptr< others::StaffComposite > musx::dom::others::StaffComposite::createCurrent ( const DocumentPtr &  document, Cmper  partId, InstCmper  staffId, MeasCmper  measId, Edu  eduPosition  )

static

Calculates the current staff at the specified metric position by applying all relevant staff styles,.

Note that the Finale app has logic to assure that no two assigments modify the same staff properties at the same metric position. If this occurs despite Finale's code, the last one processed is the one that takes effect.

Parameters

document	The document to search
partId	The ID of the linked part or score
staffId	The Staff cmper of the base staff for which to apply staff styles
measId	The measure location to search
eduPosition	The Edu position within the measure to search

Returns

The composite result or null if staffId is not valid.

getPartId()

Cmper musx::dom::others::StaffComposite::getPartId ( ) const

inlinefinaloverridevirtual

Overrides Base function to return the requested part id instead of the Staff's source part id (which is always the score)

Reimplemented from musx::dom::Base.