Represents a tuplet sequence within a sequence. More...

#include <Sequence.h>

Inheritance diagram for mnx::sequence::Tuplet:

Classes
struct	Required
	initializer class for Tuplet More...

Public Member Functions
	Tuplet (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing Tuplet objects.

	Tuplet (Base &parent, std::string_view key, const NoteValueQuantity::Required &innerNoteValueQuant, const NoteValueQuantity::Required &outerNoteValueQuant)
	Creates a new Tuplet class as a child of a JSON element.

	operator Required () const
	Implicit conversion back to Required.

	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (AutoYesNo, bracket, AutoYesNo::Auto)
	bracket style

	MNX_REQUIRED_CHILD (ContentArray, content)
	array of events, tuplets, and grace notes

	MNX_REQUIRED_CHILD (NoteValueQuantity, inner,(unsigned, count),(const NoteValue::Required &, noteValue))
	Inner quantity: 3 quarters in the time of 2 quarters.

	MNX_REQUIRED_CHILD (NoteValueQuantity, outer,(unsigned, count),(const NoteValue::Required &, noteValue))

	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (TupletDisplaySetting, showNumber, TupletDisplaySetting::Inner)
	How and whether to show the tuplet number(s)

	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (TupletDisplaySetting, showValue, TupletDisplaySetting::NoNumber)
	How and whether to show the tuplet note value(s)

	MNX_OPTIONAL_PROPERTY (int, staff)
	Staff number override (e.g., for cross-staff notes.)

FractionValue	ratio () const
	Return the triplet ratio as a FractionValue.

Public Member Functions inherited from mnx::ContentObject
	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (std::string, type, std::string(defaultType()))
	determines our type in the JSON

template<typename T , std::enable_if_t< std::is_base_of_v< ContentObject, T >, int > = 0>
T	get () const
	Retrieve an element as a specific type.

template<typename T , std::enable_if_t< std::is_base_of_v< ContentObject, T >, int > = 0>
T	getTypedObject () const
	Constructs an object of type `T` if its type matches the JSON type.

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 Member Functions
static Required	make (const NoteValueQuantity::Required &innerNoteValueQuant, const NoteValueQuantity::Required &outerNoteValueQuant)
	Create a Required instance for Tuplet.

Static Public Attributes
static constexpr std::string_view	ContentTypeValue = "tuplet"
	type value that identifies the type within the content array

Additional Inherited Members
Protected Member Functions inherited from mnx::ContentObject
virtual std::string_view	defaultType () const

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 tuplet sequence within a sequence.

Constructor & Destructor Documentation

◆ Tuplet()

mnx::sequence::Tuplet::Tuplet	(	Base &	parent,
		std::string_view	key,
		const NoteValueQuantity::Required &	innerNoteValueQuant,
		const NoteValueQuantity::Required &	outerNoteValueQuant
	)

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
innerNoteValueQuant	Inner amount
outerNoteValueQuant	Outer amount

Member Function Documentation

◆ MNX_OPTIONAL_PROPERTY_WITH_DEFAULT()

mnx::sequence::Tuplet::MNX_OPTIONAL_PROPERTY_WITH_DEFAULT	(	TupletDisplaySetting	,
		showNumber	,
		TupletDisplaySetting::Inner
	)

How and whether to show the tuplet number(s)

Todo:: orient

◆ MNX_REQUIRED_CHILD()

mnx::sequence::Tuplet::MNX_REQUIRED_CHILD	(	NoteValueQuantity	,
		outer	,
		(unsigned, count)	,
		(const NoteValue::Required &, noteValue)
	)

Outer quantity: 3 quarters in the time of 2 quarters

Classes

Public Member Functions

Static Public Member Functions