MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::DocumentElement Class Reference

Base for DOM classes that belong to a Document. More...

#include <DocumentElement.h>

+ Inheritance diagram for musx::dom::DocumentElement:

Public Member Functions

virtual ~DocumentElement () noexcept(false)=default
 Virtual destructor for polymorphic behavior.
 
DocumentPtr getDocument () const
 Gets a reference to the Document.
 
Cmper getPartId () const
 Gets the part id associated with this instance.
 

Protected Member Functions

 DocumentElement (const DocumentWeakPtr &document, Cmper partId)
 Constructs the document element.
 
 DocumentElement (const DocumentElement &)=default
 explicit default copy constructor
 
 DocumentElement (DocumentElement &&) noexcept=default
 explicit default move constructor
 
DocumentElementoperator= (const DocumentElement &)
 no-op copy assignment operator allows subclasses to copy their values.
 
DocumentElementoperator= (DocumentElement &&) noexcept
 no-op move assignment operator allows subclasses to move their values.
 

Detailed Description

Base for DOM classes that belong to a Document.

This base provides a document context with a part id.

Constructor & Destructor Documentation

◆ DocumentElement()

musx::dom::DocumentElement::DocumentElement ( const DocumentWeakPtr document,
Cmper  partId 
)
inlineprotected

Constructs the document element.

Parameters
documentA weak pointer to the parent document.
partIdThe part id associated with this instance.

Member Function Documentation

◆ getDocument()

DocumentPtr musx::dom::DocumentElement::getDocument ( ) const
inline

Gets a reference to the Document.

Returns
A pointer to the Document instance.