Represents the termination segment of the smart shape. More...

#include <SmartShape.h>

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

Public Member Functions
	TerminationSeg (const DocumentWeakPtr &document)
	Constructor function.

void	integrityCheck () override
	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.

bool	requireAllFields () const override
	ignore other fields because they are difficult to figure out

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.

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

Public Attributes
std::shared_ptr< EndPoint >	endPoint
	Endpoint information (xml node is `<endPt>`)

std::shared_ptr< EndPointAdjustment >	endPointAdj
	Endpoint adjustment information (xml node is `<endPtAdj>`)

std::shared_ptr< EndPointAdjustment >	breakAdj

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 the termination segment of the smart shape.

Member Function Documentation

◆ integrityCheck()

void musx::dom::others::SmartShape::TerminationSeg::integrityCheck ( )

inlineoverridevirtual

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.

The default implementation should always be called inside an overridden implementation.

Exceptions

musx::dom::integrity_error if there is a problem.

Reimplemented from musx::dom::Base.

◆ requireAllFields()

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

inlineoverridevirtual

ignore other fields because they are difficult to figure out

Reimplemented from musx::dom::Base.

Member Data Documentation

◆ breakAdj

std::shared_ptr<EndPointAdjustment> musx::dom::others::SmartShape::TerminationSeg::breakAdj

System break adjustment for first or last system (depending which endpoint it is) Systems other than the first or last are controlled with instances of details::CenterShape.

Public Member Functions

Static Public Member Functions