mnx::sequence::Note Class Reference

Represents a single note (i.e., within a chord) within a musical event within a sequence. More...

#include <Sequence.h>

Inheritance diagram for mnx::sequence::Note:

Public Member Functions
	Note (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing Note objects.
	Note (Base &parent, const std::string_view &key, NoteStep step, int octave, std::optional< int > alter=std::nullopt)
	Creates a new Note class as a child of a JSON element.
	MNX_OPTIONAL_CHILD (AccidentalDisplay, accidentalDisplay)
	the forced show/hide state of the accidental
	MNX_REQUIRED_CHILD (Pitch, pitch)
	the pitch of the note
	MNX_OPTIONAL_CHILD (TransposeWritten, written)
	How to write this note when it is displayed transposed.
Public Member Functions inherited from mnx::sequence::NoteBase
	MNX_OPTIONAL_PROPERTY (int, staff)
	Staff number override (e.g., for cross-staff notes.)
	MNX_OPTIONAL_NAMED_PROPERTY (std::string, styleClass, "class")
	style class
	MNX_OPTIONAL_CHILD (Array< Tie >, ties)
	The (forward) ties, if any.
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, const 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, const 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_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)
	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.
json_pointer	pointer () const
	Returns the json_pointer for this node.

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, const std::string_view &key)
	Construct a Base reference as a child inside a parent node.
template<typename T >
T	getChild (const std::string_view &key) const
	Retrieves and validates a required child node.
template<typename T >
T	setChild (const std::string_view &key, const T &value)
	Sets a child node.
template<typename T >
std::optional< T >	getOptionalChild (const std::string_view &key) const
	Retrieves an optional child node.

Detailed Description

Represents a single note (i.e., within a chord) within a musical event within a sequence.

Constructor & Destructor Documentation

Note()

mnx::sequence::Note::Note ( Base &  parent, const std::string_view &  key, NoteStep  step, int  octave, std::optional< int >  alter = std::nullopt  )

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
step	The letter spelling of the note.
octave	The octave number of the note (where C4 is middle C).
alter	The chromatic alteration of the note (positive for sharp, negative for flat)