Represents an ottava starting with the next event in the sequence. More...

#include <Part.h>

Inheritance diagram for mnx::part::Ottava:

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

	Ottava (Base &parent, std::string_view key, OttavaAmount value, const FractionValue &position, int endMeasureId, const FractionValue &endPosition)
	Creates a new Space class as a child of a JSON element.

	MNX_REQUIRED_CHILD (MeasureRhythmicPosition, end)

	MNX_REQUIRED_CHILD (RhythmicPosition, position)
	The start position of the ottava.

	MNX_OPTIONAL_PROPERTY (int, staff)
	The staff (within the part) this ottava applies to.

	MNX_REQUIRED_PROPERTY (OttavaAmount, value)
	The type of ottava (amount of displacement, in octaves)

	MNX_OPTIONAL_PROPERTY (std::string, voice)
	Optionally specify the voice this ottava applies to.

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.

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 an ottava starting with the next event in the sequence.

Constructor & Destructor Documentation

◆ Ottava()

mnx::part::Ottava::Ottava	(	Base &	parent,
		std::string_view	key,
		OttavaAmount	value,
		const FractionValue &	position,
		int	endMeasureId,
		const FractionValue &	endPosition
	)

inline

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

Parameters

parent	The parent class instance.
key	The JSON key to use for embedding in parent.
value	the value (type) of ottava.
position	the start position of the ottava.
endMeasureId	The end measure of the ottava.
endPosition	The position within the end measure of the ottava. (The ottava includes events that start at this position.)

Member Function Documentation

◆ MNX_REQUIRED_CHILD() [1/2]

mnx::part::Ottava::MNX_REQUIRED_CHILD	(	MeasureRhythmicPosition	,
		end
	)

The end of the ottava (includes any events starting at this location)

◆ MNX_REQUIRED_CHILD() [2/2]

mnx::part::Ottava::MNX_REQUIRED_CHILD	(	RhythmicPosition	,
		position
	)

The start position of the ottava.

Todo:: orient