musx::dom::others::FretInstrument Class Reference

Describes a fretted instrument (strings, frets, name, clef). It is used for both TAB notation and FretboardGroup instances. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::FretInstrument:

Classes
class	StringInfo
	Information for a single string of the fretted instrument. More...

Public Member Functions
	FretInstrument (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor.
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::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 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< FretInstrument > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	numFrets {}
	Number of frets.
int	numStrings {}
	Number of strings (max is 24)
std::string	name
	Display name.
std::vector< std::shared_ptr< StringInfo > >	strings
	One entry per string: strings.size() should equal numStrings.
std::vector< int >	fretSteps
ClefIndex	speedyClef {}
	The clef to use when entering notes for this instrument in Speedy Entry.

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

Describes a fretted instrument (strings, frets, name, clef). It is used for both TAB notation and FretboardGroup instances.

The cmper is an arbitrary unique number referenced by Staff, FretboardGroup, and options::ChordOptions.

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

Member Function Documentation

integrityCheck()

void musx::dom::others::FretInstrument::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

fretSteps

std::vector<int> musx::dom::others::FretInstrument::fretSteps

Sequence of fret intervals (in half-steps) measured from the open string. If empty, all frets are treated as consecutive half-steps (chromatic). If shorter than numFrets, any unspecified frets default to one half-step above the previous value. (xml node is <diatonic>)