musx::dom::others::Staff::Transposition Class Reference

Encapsulates transposition options for a staff. More...

#include <Staff.h>

Inheritance diagram for musx::dom::others::Staff::Transposition:

Public Member Functions
bool	isSame (const Transposition &other) const
	Returns true if the input has the same contents as this.
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.
	ContainedClassBase (const MusxInstance< Base > &parent)
	Constructs a ContainedClassBase object.
Public Member Functions inherited from musx::dom::ContainedClassBase
	ContainedClassBase (const MusxInstance< Base > &parent)
	Constructs a ContainedClassBase object.
template<typename ParentClass = Base>
MusxInstance< ParentClass >	getParent () const
	Get the parent.
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< Transposition > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
bool	setToClef {}
	If true, forces the clef in Staff::transposedClef.
bool	noSimplifyKey {}
	Inverse of "Simplify Key" (xml node is <noKeyOpt>)
std::shared_ptr< KeySigTransposition >	keysig
	Shared pointer to the key signature transposition details, if any.
std::shared_ptr< ChromaticTransposition >	chromatic
	Shared pointer to the chromatic transposition details, if any.

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::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

Encapsulates transposition options for a staff.

Contains flags (such as setToClef and noKeyOpt) and shared pointers to embedded transposition types: key signature and chromatic.

Member Function Documentation

ContainedClassBase()

musx::dom::ContainedClassBase::ContainedClassBase ( const MusxInstance< Base > &  parent )

inline

Constructs a ContainedClassBase object.

Parameters

parent

A shared pointer to the parent document.

integrityCheck()

void musx::dom::others::Staff::Transposition::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.