musx::dom::others::FileDescription Class Reference

Describes the locator flavor Finale used for the associated file/graphic. More...

#include <Graphics.h>

Inheritance diagram for musx::dom::others::FileDescription:

Public Types
enum class	PathType {   DosPath , MacFsSpec , MacAlias , MacPosixPath ,   MacUrlBookmark }
	Defines the possible path types. More...
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
	FileDescription (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.
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 void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	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.

Static Public Member Functions
static const xml::XmlElementArray< FileDescription > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
uint32_t	version {}
	Always 0x100, meaning perhaps "v1.0". (This was intended for tracking changes to the data format, but it was never used.)
int	volRefNum {}
	Classic Mac OS volume reference number, used with legacy MacFsSpec path.
int	dirId {}
	Classic Mac OS directory ID, used with legacy MacFsSpec path. (xml node is <dirID>)
PathType	pathType
	Path type. (Determines which of FileAlias and FileUrlBookmark to use as well as how to interpret FilePath::path.)
Cmper	pathId {}
	Cmper of FilePath? It is unknown if this value ever differs from the cmper of FileDescription. (xml node is <pathID>)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "fileDesc"
	The XML node name for this type.

Additional Inherited Members
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.
OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
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

Describes the locator flavor Finale used for the associated file/graphic.

The DOM does not enforce/interpret pathType semantics. The pathType is preserved as-is.

Member Enumeration Documentation

PathType

enum class musx::dom::others::FileDescription::PathType

strong

Defines the possible path types.

Enumerator
DosPath	Path is a DOS filepath.
MacFsSpec	Path is a Mac FS Spec.
MacAlias	Path is defined by mac alias. (See FileAlias.)
MacPosixPath	Path is a POSIX filepath.
MacUrlBookmark	Path is a Mac URL bookmark. (See FileUrlBookmark.)