Represents an explicit directive to show or hide an accidental. More...

#include <Sequence.h>

Inheritance diagram for mnx::sequence::AccidentalDisplay:

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

	AccidentalDisplay (Base &parent, const std::string_view &key, bool showAcci)
	Creates a new Pitch class as a child of a JSON element.

	MNX_OPTIONAL_CHILD (AccidentalEnclosure, enclosure)
	The enclosure type (brackets or parentheses). Omit if none.

	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (bool, force, false)
	Whether this accidental was set intentionally (e.g., a courtesy accidental).

	MNX_REQUIRED_PROPERTY (bool, show)
	Whether to show or hide the accidental.

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 an explicit directive to show or hide an accidental.

Constructor & Destructor Documentation

mnx::sequence::AccidentalDisplay::AccidentalDisplay	(	Base &	parent,
		const std::string_view &	key,
		bool	showAcci
	)

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 the parent.
showAcci	Show or hide the accidental.