Represents the attributes of a Finale staff group that brackets staves. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::StaffGroup:

Public Types
enum class	DrawBarlineStyle { OnlyOnStaves , ThroughStaves , Mensurstriche }
	Enum for how to draw group barlines. More...

enum class	HideStaves { Normally , AsGroup , None }
	Enum for optimization options. More...

using	BarlineType = others::Measure::BarlineType
	Enum for barline justification.

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
	StaffGroup (const DocumentWeakPtr &document, Cmper partId, Base::ShareMode shareMode, Cmper cmper1, Cmper cmper2)
	Constructor.

util::EnigmaParsingContext	getFullNameCtx () const
	Get the raw text context for the full staff group name.

std::string	getFullName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Get the full staff group name without Enigma tags.

util::EnigmaParsingContext	getAbbreviatedNameCtx () const
	Get the raw text context for the abbreviated staff group name.

std::string	getAbbreviatedName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Get the abbreviated staff group name without Enigma tags.

MusxInstance< others::MultiStaffInstrumentGroup >	getMultiStaffInstGroup () const
	Returns the others::MultiStaffInstrumentGroup for this group if it is part of one. Otherwise nullptr.

util::EnigmaParsingContext	getFullInstrumentNameCtx () const
	Returns the raw text context for the full instrument name for this group, with autonumbering context if any.

std::string	getFullInstrumentName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Returns the full instrument name for this group without Enigma tags and with autonumbering (if any).

util::EnigmaParsingContext	getAbbreviatedInstrumentNameCtx () const
	Returns the raw text context for the abbreviated instrument name for this group, with autonumbering context if any.

std::string	getAbbreviatedInstrumentName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
	Returns the abbreviated instrument name for this group without Enigma tags and with autonumbering (if any)

bool	isAllMeasures () const
	Returns true if this group spans all measures.

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

Public Attributes
StaffCmper	startInst {}
	Starting staff ID.

StaffCmper	endInst {}
	Ending staff ID.

MeasCmper	startMeas {}
	Starting measure number.

MeasCmper	endMeas {}
	Ending measure number.

Cmper	fullNameId {}
	Full name TextBlock cmper (xml node is `<fullID>`)

int	fullNameXadj {}
	Horizontal adjustment for full name (xml node is `<fullXadj>`)

int	fullNameYadj {}
	Vertical adjustment for full name (xml node is `<fullYadj>`)

std::shared_ptr< Bracket >	bracket {}
	Bracket Options. The factory guarantees this value to exist.

BarlineType	barlineType {}
	Group barline type (xml node is `<barline>`)

AlignJustify	fullNameJustify {}
	Full name justification (xml node is `<fullJustify>`)

AlignJustify	abbrvNameJustify {}
	Abbreviated name justification (xml node is `<abbrvJustify>`)

DrawBarlineStyle	drawBarlines
	"Draw Barlines" option (xml node is `<groupBarlineStyle>`)

bool	ownBarline {}
	"Use Alternate Group Barline"

bool	fullNameIndivPos {}
	Indicates if full name has individual position (xml node is `<fullIndivPos>`)

bool	abbrvNameIndivPos {}
	Indicates if abbreviated name has individual position (xml node is `<abbrvIndivPos>`)

bool	hideName {}
	Inverse of "Show Group Name".

Cmper	abbrvNameId {}
	Abbreviated name TextBlock cmper (xml node is `<abbrvID>`)

int	abbrvNameXadj {}
	Horizontal adjustment for abbreviated name (xml node is `<abbrvXadj>`)

int	abbrvNameYadj {}
	Vertical adjustment for abbreviated name (xml node is `<abbrvYadj>`)

AlignJustify	fullNameAlign {}
	Full name horizontal alignment (xml node is `<fullHAlign>`)

AlignJustify	abbrvNameAlign {}
	Abbreviated name horizontal alignment (xml node is `<abbrvHAlign>`)

bool	fullNameExpand {}
	"Expand Single Word" for full name (xml node is `<fullExpand>`)

bool	abbrvNameExpand {}
	"Expand Single Word" for abbreviated name (xml node is `<abbrvExpand>`)

HideStaves	hideStaves {}
	"When Hiding Empty Staves" option (xml node is `<optimize>`)

Cmper	multiStaffGroupId {}

std::unordered_set< StaffCmper >	staves
	Calculated list of staves in the group.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "staffGroup"
	XML node name for this type.

Additional Inherited Members
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 the attributes of a Finale staff group that brackets staves.

This class is identified by the XML node name "staffGroup".

Member Enumeration Documentation

◆ DrawBarlineStyle

enum class musx::dom::details::StaffGroup::DrawBarlineStyle

strong

Enum for how to draw group barlines.

Enumerator
OnlyOnStaves	Default value (may not appear in xml)
ThroughStaves	Draw barlines through staves (xml value is "group")
Mensurstriche	Draw barlines between staves (xml value is "Mensurstriche" with capitalization)

◆ HideStaves

enum class musx::dom::details::StaffGroup::HideStaves

strong

Enum for optimization options.

Enumerator
Normally	Hide staves as if there were no StaffGroup (this is the default and may not appear in the xml)
AsGroup	Hide staves only if all staves are empty.
None	Never hide the staves in this StaffGroup.

Constructor & Destructor Documentation

◆ StaffGroup()

musx::dom::details::StaffGroup::StaffGroup	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		Base::ShareMode	shareMode,
		Cmper	cmper1,
		Cmper	cmper2
	)

inline

Constructor.

Parameters

document	The document owner of this instance
partId	The part that owns this staff group
shareMode	The sharing mode deduced from xml attributes
cmper1	In modern Finale files, all groups have 0 for cmper1. In legacy files this was a cmper for a others::StaffUsed list.
cmper2	The identifier for the StaffGroup.

Member Function Documentation

◆ getAbbreviatedInstrumentName()

std::string musx::dom::details::StaffGroup::getAbbreviatedInstrumentName ( util::EnigmaString::AccidentalStyle accidentalStyle = util::EnigmaString::AccidentalStyle::Ascii ) const

Returns the abbreviated instrument name for this group without Enigma tags and with autonumbering (if any)

Note: Ordinal prefix numbering is currently supported only for English.

Parameters

accidentalStyle The style for accidental subsitution in names like "Clarinet in Bb".

Returns: Abbreviated instrument name if this group is associated with a others::MultiStaffInstrumentGroup. Otherwise getAbbreviatedName.

◆ getAbbreviatedInstrumentNameCtx()

util::EnigmaParsingContext musx::dom::details::StaffGroup::getAbbreviatedInstrumentNameCtx ( ) const

Returns the raw text context for the abbreviated instrument name for this group, with autonumbering context if any.

Returns: Abbreviated instrument name context if this group is associated with a others::MultiStaffInstrumentGroup. Otherwise abbrvNameId context.

◆ getAbbreviatedName()

std::string musx::dom::details::StaffGroup::getAbbreviatedName ( util::EnigmaString::AccidentalStyle accidentalStyle = util::EnigmaString::AccidentalStyle::Ascii ) const

Get the abbreviated staff group name without Enigma tags.

Parameters

accidentalStyle The style for accidental subsitution in names like "Clarinet in Bb".

◆ getFullInstrumentName()

std::string musx::dom::details::StaffGroup::getFullInstrumentName ( util::EnigmaString::AccidentalStyle accidentalStyle = util::EnigmaString::AccidentalStyle::Ascii ) const

Returns the full instrument name for this group without Enigma tags and with autonumbering (if any).

Note: Ordinal prefix numbering is currently supported only for English.

Parameters

accidentalStyle The style for accidental subsitution in names like "Clarinet in Bb".

Returns: Full instrument name if this group is associated with a others::MultiStaffInstrumentGroup. Otherwise getFullName.

◆ getFullInstrumentNameCtx()

util::EnigmaParsingContext musx::dom::details::StaffGroup::getFullInstrumentNameCtx ( ) const

Returns the raw text context for the full instrument name for this group, with autonumbering context if any.

Returns: Full instrument name context if this group is associated with a others::MultiStaffInstrumentGroup. Otherwise fullNameId context.

◆ getFullName()

std::string musx::dom::details::StaffGroup::getFullName ( util::EnigmaString::AccidentalStyle accidentalStyle = util::EnigmaString::AccidentalStyle::Ascii ) const

Get the full staff group name without Enigma tags.

Parameters

accidentalStyle The style for accidental subsitution in names like "Clarinet in Bb".

◆ integrityCheck()

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

Member Data Documentation

◆ multiStaffGroupId

Cmper musx::dom::details::StaffGroup::multiStaffGroupId {}

Calculated cmper for others::MultiStaffGroupId, if any. This value is not in the xml. It is set by the factory with the Resolver function for others::MultiStaffGroupId.

Note: This is the value (if any) for a defined multistaff instrument. Normally you should use Document::getInstruments to determine the instrument groupings. These include any that the factory detected from legacy staves or other special circumstances.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DrawBarlineStyle

◆ HideStaves

Constructor & Destructor Documentation

◆ StaffGroup()

Member Function Documentation

◆ getAbbreviatedInstrumentName()

◆ getAbbreviatedInstrumentNameCtx()

◆ getAbbreviatedName()

◆ getFullInstrumentName()

◆ getFullInstrumentNameCtx()

◆ getFullName()

◆ integrityCheck()

Member Data Documentation

◆ multiStaffGroupId