Represents the pitch of a note. More...

#include <Sequence.h>

Inheritance diagram for mnx::sequence::Pitch:

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

	Pitch (Base &parent, const std::string_view &key, NoteStep inpStep, int inpOctave, std::optional< int > inpAlter=std::nullopt)
	Creates a new Pitch class as a child of a JSON element.

	MNX_OPTIONAL_PROPERTY (int, alter)
	chromatic alteration

	MNX_REQUIRED_PROPERTY (int, octave)
	the octave number

	MNX_REQUIRED_PROPERTY (NoteStep, step)
	the note step, (i.e., "A".."G")

bool	isSamePitch (const Pitch &src) const
	Checks if the input pitch is the same as this pitch, including enharmonic equivalents.

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.

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 the pitch of a note.

Constructor & Destructor Documentation

◆ Pitch()

mnx::sequence::Pitch::Pitch	(	Base &	parent,
		const std::string_view &	key,
		NoteStep	inpStep,
		int	inpOctave,
		std::optional< int >	inpAlter = `std::nullopt`
	)

inline

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

Parameters

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

Member Function Documentation

◆ isSamePitch()

bool mnx::sequence::Pitch::isSamePitch ( const Pitch & src ) const

Checks if the input pitch is the same as this pitch, including enharmonic equivalents.