musx::dom::others::SmartShape::EndPoint Class Reference

Represents an endpoint of the smart shape. More...

#include <SmartShape.h>

Inheritance diagram for musx::dom::others::SmartShape::EndPoint:

Public Member Functions
	EndPoint (const DocumentWeakPtr &document)
	Constructor function.
Edu	calcEduPosition () const
	Calculates the edu position of the endpoint, based on whether it is an edu or an entry.
EntryInfoPtr	calcAssociatedEntry () const
	Calculates the entry associated with the endpoint.
bool	requireAllFields () const override
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
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 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.

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

Public Attributes
InstCmper	staffId {}
	Staff ID (xml node is <inst>)
MeasCmper	measId {}
	Measure ID (xml node is <meas>)
Edu	eduPosition {}
	Edu position of endpoint (xml node is <edu>)
EntryNumber	entryNumber {}
	Entry number. Zero if the endpoint is not entry-attached. (xml node is <entryNum>)

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::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

Represents an endpoint of the smart shape.

Member Function Documentation

calcAssociatedEntry()

EntryInfoPtr musx::dom::others::SmartShape::EndPoint::calcAssociatedEntry

(

)

const

Calculates the entry associated with the endpoint.

Returns

The entry if the endpoint is entry-attached or within 1 Edu of an entry. Null if not.

requireAllFields()

bool musx::dom::others::SmartShape::EndPoint::requireAllFields ( ) const

inlineoverridevirtual

Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Some classes make it difficult to discover all the possible xml tags that might be used for all its options. An example is others::TextBlock. By overriding this function, a class can allow its members to be discovered as needed without causing error messages or throwing exceptions.

Remarks

This value only escapes errors on fields. Enum values must still have all values provided to avoid error messages or exceptions.

Reimplemented from musx::dom::Base.