mnx::part::PartTransposition Class Reference

Describes a part's instrument transposition. More...

#include <Part.h>

Inheritance diagram for mnx::part::PartTransposition:

Public Member Functions
	PartTransposition (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing Clef instances.
	PartTransposition (Base &parent, std::string_view key, int diatonic, int chromatic)
	Creates a new Clef class as a child of a JSON element.
	MNX_REQUIRED_CHILD (Interval, interval)
	the transposition interval
	MNX_OPTIONAL_PROPERTY (int, keyFifthsFlipAt)
	the number of sharps (positive) or flats (negative) at which to simplify the key signature
	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (bool, prefersWrittenPitches, false)
	concert-pitch score. (Examples could be piccolo, double base, glockenspiel, etc.)
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

Describes a part's instrument transposition.

Constructor & Destructor Documentation

PartTransposition()

mnx::part::PartTransposition::PartTransposition ( Base &  parent, std::string_view  key, int  diatonic, int  chromatic  )

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
diatonic	The number of diatonic steps in the interval (negative is down)
chromatic	The number of 12-EDO chromatic halfsteps in the interval (negative is down)

Member Function Documentation

MNX_OPTIONAL_PROPERTY_WITH_DEFAULT()

mnx::part::PartTransposition::MNX_OPTIONAL_PROPERTY_WITH_DEFAULT	(	bool	,
		prefersWrittenPitches	,
		false
	)

concert-pitch score. (Examples could be piccolo, double base, glockenspiel, etc.)

if true, this instrument prefers displaying written pitches even in the context of