mnx::part::Measure Class Reference

Represents a single measure in a part in an MNX document. It contains the majority of the musical information in its sequences. More...

#include <Part.h>

Inheritance diagram for mnx::part::Measure:

Public Member Functions
	Measure (Base &parent, std::string_view key)
	Creates a new Measure class as a child of a JSON element.
	MNX_OPTIONAL_CHILD (Array< Arpeggio >, arpeggios)
	the arpeggios in this measure
	MNX_OPTIONAL_CHILD (Array< Beam >, beams)
	the beams in this measure
	MNX_OPTIONAL_CHILD (Array< PositionedClef >, clefs)
	the clef changes in this bar
	MNX_OPTIONAL_CHILD (Array< Dynamic >, dynamics)
	the dynamics in this measure
	MNX_OPTIONAL_CHILD (Array< NonArpeggio >, nonArpeggios)
	the non-arpeggios in this measure
	MNX_OPTIONAL_CHILD (Array< Ottava >, ottavas)
	the ottavas in this measure
	MNX_REQUIRED_CHILD (Array< Sequence >, sequences)
	sequences that contain all the musical details in each measure
mnx::global::Measure	getGlobalMeasure () const
	Returns the global measure for this part measure.
std::optional< TimeSignature >	calcCurrentTime () const
	Caculates the time signature at this measure.
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 object that owns the content array this element belongs to wrapped as the specified template type.
	Object ()
	Constructor fresh document or detached instance.
	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 ()
	Constructor fresh document or detached instance.
	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.
void	setExtension (const std::string &key, const json &value)
	Sets a vendor extension value in _x, creating _x when needed.
std::optional< json >	getExtension (const std::string &key) const
	Gets a vendor extension value from _x.
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 , typename Scope = scope::Default>
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 ContentObject::container.)
json_pointer	pointer () const
	Returns the json_pointer for this node.
Document	document () const
	Returns the document root.
bool	empty () const
	Returns true if the object is empty.

Static Public Attributes
static constexpr std::string_view	JsonSchemaTypeName = "part-measure"
	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 measure in a part in an MNX document. It contains the majority of the musical information in its sequences.

Constructor & Destructor Documentation

Measure()

mnx::part::Measure::Measure ( Base &  parent, std::string_view  key  )

inline

Creates a new Measure class as a child of a JSON element.

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.

Member Function Documentation

calcCurrentTime()

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

(

)

const

Caculates the time signature at this measure.

Returns

The time signagure or std::nullopt if none.

getGlobalMeasure()

global::Measure mnx::part::Measure::getGlobalMeasure

(

)

const

Returns the global measure for this part measure.

Exceptions

std::logic_error

if the global measure does not exist.