musx::dom::details::CustomDownStem Class Reference

Custom stem for downstem context. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::CustomDownStem:

Public Member Functions
	CustomStem (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
	Constructor.
Public Member Functions inherited from musx::dom::details::CustomStem
	CustomStem (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
	Constructor.
bool	calcIsHiddenStem () const
	Calculates if this custom stem record hides the stem. The stem is determined to be hidden if one of the following is true.
Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the entnum key value.
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.
virtual Cmper	getPartId () const
	Gets the partId for this instance (or SCORE_PARTID for score)
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 = "stemDefDown"
	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.
Static Public Member Functions inherited from musx::dom::details::CustomStem
static const xml::XmlElementArray< CustomStem > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.
Public Attributes inherited from musx::dom::details::CustomStem
Cmper	shapeDef {}
	The Cmper of the associated others::ShapeDef. Setting this value to zero hides the stem.
Evpu	xOffset {}
	Optional horizontal displacement. (xml node is <xdisp>)
Evpu	yOffset {}
	Optional vertical displacement. (xml node is <ydisp>)
Protected Member Functions inherited from musx::dom::EntryDetailsBase
	EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
	Constructs a EntryDetailsBase object.
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.
	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

Custom stem for downstem context.

Entry::stemDetail is set if the entry has a custom down stem.

Member Function Documentation

CustomStem()

musx::dom::details::CustomStem::CustomStem ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, EntryNumber  entnum  )

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the associated document.
partId	The part this is for.
shareMode	The sharing mode.
entnum	The entry number this stem applies to.