mnx::global::Measure Class Reference

Represents a single global measure instance within an MNX document. More...

#include <Global.h>

Inheritance diagram for mnx::global::Measure:

Public Member Functions
	MNX_OPTIONAL_CHILD (Barline, barline)
	optional barline for this measure
	MNX_OPTIONAL_CHILD (Ending, ending)
	optional ending ("volta bracket") for this measure
	MNX_OPTIONAL_CHILD (Fine, fine)
	optional fine direction for this measure
	MNX_OPTIONAL_PROPERTY (int, index)
	the measure index which is used to refer to this measure by other classes in the MNX document
	MNX_OPTIONAL_CHILD (Jump, jump)
	optional jump direction for this measure
	MNX_OPTIONAL_CHILD (KeySignature, key)
	optional key signature/key change for this measure
	MNX_OPTIONAL_PROPERTY (int, number)
	visible measure number. Use calcMeasureIndex to get the default value.
	MNX_OPTIONAL_CHILD (RepeatEnd, repeatEnd)
	if present, indicates that there is backwards repeat
	MNX_OPTIONAL_CHILD (RepeatStart, repeatStart)
	if present, indicates that a repeated section starts here
	MNX_OPTIONAL_CHILD (Segno, segno)
	if present, indicates that a segno marker is here
	MNX_OPTIONAL_CHILD (Array< Tempo >, tempos)
	the tempo changes within the measure, if any
	MNX_OPTIONAL_CHILD (TimeSignature, time)
	if present, indicates a meter change
BarlineType	calcBarlineType () const
	Calculates the barline type for this measure.
int	calcMeasureIndex () const
	Calculates the measure index for this measure.
std::optional< TimeSignature >	calcCurrentTime () const
	Calculates the current time signature by searching backwards.
Public Member Functions inherited from mnx::ArrayElementObject
size_t	calcArrayIndex () const
	Calculates the array index of the current instance within the array.
template<typename ContainerType >
ContainerType	container () const
	Returns the container of the array this element belongs to wrapped as the specified template type.
	Object (const std::shared_ptr< json > &root, json_pointer pointer)
	Wraps an Object class around an existing JSON object node.
	Object (Base &parent, std::string_view key)
	Creates a new Object class as a child of a JSON node.
Public Member Functions inherited from mnx::Object
	Object (const std::shared_ptr< json > &root, json_pointer pointer)
	Wraps an Object class around an existing JSON object node.
	Object (Base &parent, std::string_view key)
	Creates a new Object class as a child of a JSON node.
	MNX_OPTIONAL_PROPERTY (std::string, _c)
	An optional comment. This serves a similar function as XML or HTML comments.
	MNX_OPTIONAL_CHILD (Object, _x)
	Vendor-defined dictionary.
	MNX_OPTIONAL_PROPERTY (std::string, id)
	Uniquely identifies the object.
Public Member Functions inherited from mnx::Base
	Base (const Base &src)
	Copy constructor.
	Base (Base &&src) noexcept
	Move constructor.
Base &	operator= (const Base &src)
	Copy assignment operator.
Base &	operator= (Base &&src)
	Move assignment operator.
std::string	dump (int indents=-1) const
	Dumps the branch to a string. Useful in debugging.
template<typename T >
T	parent () const
	Returns the parent object for this node.
template<typename T >
std::optional< T >	getEnclosingElement () const
	Returns the enclosing array element for this instance. If T is a type that can be nested (e.g. ContentObject), the highest level instance is returned. (To get the lowest level immediate container, use ArrayElementObject::container.)
json_pointer	pointer () const
	Returns the json_pointer for this node.
Document	document () const
	Returns the document root.

Static Public Attributes
static constexpr std::string_view	JsonSchemaTypeName = "measure-global"
	required for mapping

Additional Inherited Members
Protected Member Functions inherited from mnx::Base
json &	ref () const
	Convert this node for retrieval.
json &	ref ()
	Access the JSON node for modification.
const std::shared_ptr< json > &	root () const
	Returns the root.
	Base (const std::shared_ptr< json > &root, json_pointer pointer)
	Wrap a Base instance around a specific JSON reference using a json_pointer.
	Base (json &&jsonRef, Base &parent, std::string_view key)
	Construct a Base reference as a child inside a parent node.
template<typename T >
T	getChild (std::string_view key) const
	Retrieves and validates a required child node.
template<typename T >
T	setChild (std::string_view key, const T &value)
	Sets a child node.
template<typename T >
std::optional< T >	getOptionalChild (std::string_view key) const
	Retrieves an optional child node.

Detailed Description

Represents a single global measure instance within an MNX document.

Member Function Documentation

calcBarlineType()

BarlineType mnx::global::Measure::calcBarlineType

(

)

const

Calculates the barline type for this measure.

Returns

barline().type() if barline() has a value. Otherwise the default (as defined in the MNX specification.)

calcCurrentTime()

std::optional< TimeSignature > mnx::global::Measure::calcCurrentTime

(

)

const

Calculates the current time signature by searching backwards.

Returns

The current time signature or std::nullopt if none found.

calcMeasureIndex()

int mnx::global::Measure::calcMeasureIndex

(

)

const

Calculates the measure index for this measure.

Returns

index() if it has a value or the default value (defined in the MNX specification) if it does not.