musx::dom::others::PartVoicing Class Reference

Defines voicing options for linked parts, either by selection rules or by assigning a layer. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::PartVoicing:

Public Types
enum class	VoicingType { UseSingleLayer , UseMultipleLayers }
	Choices for how notes are selected from the staff. More...
enum class	SingleLayerVoiceType { AllNotes , TopNote , BottomNote , SelectedNotes }
	Choices for how notes are selected when the staff contains only one layer. 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 Member Functions
	PartVoicing (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staff)
	Constructor function.
bool	calcShowsLayer (LayerIndex layerIndex, bool frameIsMultilayerInScore) const
	Returns if this part voicing includes the specified layer in a given frame context.
bool	calcShowsNote (const NoteInfoPtr &noteInfoPtr) const
	Returns if this part voicing includes the specified note.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper 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< PartVoicing > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
bool	enabled {}
	Indicates that this voicing is enabled.
VoicingType	voicingType {}
	Determines how notes are selected from the staff.
SingleLayerVoiceType	singleLayerVoiceType {}
	Determines how notes are selected when the staff contains only one layer. (xml node is <singleVoiceType>)
bool	select1st {}
	Select the first note from top or bottom. (See selectFromBottom.)
bool	select2nd {}
	Select the second note from top or bottom. (See selectFromBottom.)
bool	select3rd {}
	Select the third note from top or bottom. (See selectFromBottom.)
bool	select4th {}
	Select the fourth note from top or bottom. (See selectFromBottom.)
bool	select5th {}
	Select the fifth note from top or bottom. (See selectFromBottom.)
bool	selectFromBottom {}
bool	selectSingleNote {}
	If true, always include any passages containing only a single note.
LayerIndex	singleLayer {}
	The 0-based LayerIndex of the layer to uses when voicingType is UseSingleLayer.
LayerIndex	multiLayer {}
	The 0-based LayerIndex of the layer to include when the staff contains multiple layers and voicingType is UseMultipleLayers.

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

Additional Inherited Members
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.
OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&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

Defines voicing options for linked parts, either by selection rules or by assigning a layer.

In Finale, a linked part can contain multiple staves. When a staff is shared across more than one linked part, each occurrence of that staff has its own voicing definition, represented by a separate PartVoicing record. If no PartVoicing record is present, or if the PartVoicing record is disabled, the staff is included in the linked part in full.

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

Member Enumeration Documentation

SingleLayerVoiceType

enum class musx::dom::others::PartVoicing::SingleLayerVoiceType

strong

Choices for how notes are selected when the staff contains only one layer.

Enumerator
AllNotes	Select all notes. (This is the default value and may never appear in the xml.)
TopNote	Select the top note.
BottomNote	Select the bottom note. (xml value is "botNote")
SelectedNotes	Use flags select1st, select2nd, etc., to select notes. (xml value is "selected")

VoicingType

enum class musx::dom::others::PartVoicing::VoicingType

strong

Choices for how notes are selected from the staff.

Enumerator
UseSingleLayer	Display all notes from the layer specified by singleLayer. (This is the default value and may never appear in the xml.)
UseMultipleLayers	Display selected notes from one or more layer(s).

Constructor & Destructor Documentation

PartVoicing()

musx::dom::others::PartVoicing::PartVoicing ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, Cmper  staff  )

inlineexplicit

Constructor function.

Parameters

document	The document.
partId	The part ID (never SCORE_PARTID).
shareMode	The share mode (always ShareMode::None).
staff	The staff in the part that this voicing applies to.

Member Function Documentation

calcShowsLayer()

bool musx::dom::others::PartVoicing::calcShowsLayer	(	LayerIndex	layerIndex,
		bool	frameIsMultilayerInScore
	)		const

Returns if this part voicing includes the specified layer in a given frame context.

Parameters

layerIndex	The 0-based layer index to check.
frameIsMultilayerInScore	Whether the frame we are checking is multi-layer in the score.

Returns

True if the layer shows.

calcShowsNote()

bool musx::dom::others::PartVoicing::calcShowsNote

(

const NoteInfoPtr &

noteInfoPtr

)

const

Returns if this part voicing includes the specified note.

Parameters

noteInfoPtr

The note to check.

Returns

True is the note shows in this part.

Member Data Documentation

selectFromBottom

bool musx::dom::others::PartVoicing::selectFromBottom {}

If true, select notes starting at the bottom of a chord going up. If false, select notes starting at the top of a chord going down.