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

Base class for all "details" types that use entnum rather than cmper and cmper. More...

#include <BaseClasses.h>

+ Inheritance diagram for musx::dom::EntryDetailsBase:

Public Member Functions

EntryNumber getEntryNumber () const
 Gets the entnum key value.
 
- Public Member Functions inherited from musx::dom::DetailsBase
Cmper getCmper1 () const
 Gets the cmper1 key value.
 
Cmper getCmper2 () const
 Gets the cmper2 key value.
 
std::optional< IncigetInci () 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.
 
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 SharedNodesgetUnlinkedNodes () 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.
 

Protected Member Functions

 EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
 Constructs a EntryDetailsBase object.
 
- Protected Member Functions inherited from musx::dom::DetailsBase
 DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
 Constructs a DetailsBase object.
 
- 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
 
Baseoperator= (const Base &)
 no-op copy assignment operator allows subclasses to copy their values.
 
Baseoperator= (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.
 

Detailed Description

Base class for all "details" types that use entnum rather than cmper and cmper.

Constructor & Destructor Documentation

◆ EntryDetailsBase()

musx::dom::EntryDetailsBase::EntryDetailsBase ( const DocumentWeakPtr document,
Cmper  partId,
ShareMode  shareMode,
EntryNumber  entnum,
std::optional< Inci inci = std::nullopt 
)
inlineprotected

Constructs a EntryDetailsBase object.

Parameters
documentA weak pointer to the parent document
partIdThe part Id for this Detail, or zero if for score.
shareModeUsually ShareMode::All. This parameter is used with linked parts data.
entnumThe EntryNumber key value.
inciThe array index (Inci).