Template pattern for OthersBase items consisting of an array of a single item. More...

Inheritance diagram for musx::dom::OthersArray< ElementType, REQUIRED_SIZE >:

Public Member Functions
	OthersArray (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.

void	integrityCheck () override
	Override of Base::integrityCheck.

Public Member Functions inherited from musx::dom::OthersBase
Cmper	getCmper () const
	Gets the `cmper` 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.

Cmper	getPartId () const
	Gets the partId for this instance (or 0 for score)

std::shared_ptr< others::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.

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.

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.

Protected Member Functions inherited from musx::dom::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class and enforces the static constexpr XmlNodeName.

Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

template<typename ElementType, size_t REQUIRED_SIZE = 0>
class musx::dom::OthersArray< ElementType, REQUIRED_SIZE >

Template pattern for OthersBase items consisting of an array of a single item.

Template Parameters

ElementType	The type of the elements in the array
REQUIRED_SIZE	If non-zero, the required size of the array.

Member Function Documentation

template<typename ElementType , size_t REQUIRED_SIZE = 0>

void musx::dom::OthersArray< ElementType, REQUIRED_SIZE >::integrityCheck ( )

inlineoverridevirtual

Reimplemented from musx::dom::Base.

template<typename ElementType , size_t REQUIRED_SIZE = 0>

std::vector<ElementType> musx::dom::OthersArray< ElementType, REQUIRED_SIZE >::values

Values in the array Guaranteed to have REQUIRED_SIZE elements.