Base class for all "options" types. More...

Inheritance diagram for musx::dom::OptionsBase:

Protected Member Functions
	OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the OptionsBase and validates XmlNodeName in the derived class.

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.

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.

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.

Detailed Description

Base class for all "options" types.

Options types derive from this base class so they can reside in the options pool.

Constructor & Destructor Documentation

musx::dom::OptionsBase::OptionsBase	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode
	)

inlineprotected

Constructs the OptionsBase and validates XmlNodeName in the derived class.

Parameters

document	A weak pointer to the parent document
partId	Always 0. This parameter is needed for the generic factory routine.
shareMode	Always `ShareMode::All`. This parameter is needed for the generic factory routine.