mnx::sequence::Event Class Reference

Represents a musical event within a sequence. More...

#include <Sequence.h>

Inheritance diagram for mnx::sequence::Event:

Classes
struct	Required
	initializer class for Event More...

Public Member Functions
	Event (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing Event objects.
	Event (Base &parent, std::string_view key, NoteValueBase base, unsigned dots=0)
	Creates a new Event class as a child of a JSON element.
	operator Required () const
	Implicit conversion back to Required.
	MNX_REQUIRED_CHILD (NoteValue, duration,(NoteValueBase, base),(unsigned, dots))
	Symbolic duration of the event.
	MNX_OPTIONAL_CHILD (Array< KitNote >, kitNotes)
	KitNote array for percussion kit notation.
	MNX_OPTIONAL_CHILD (EventLyrics, lyrics)
	The lyric syllables on this event.
	MNX_OPTIONAL_CHILD (EventMarkings, markings)
	Articulation markings on this event.
	MNX_OPTIONAL_CHILD (Array< Note >, notes)
	MNX_OPTIONAL_CHILD (Rest, rest)
	indicates this event is a rest.
	MNX_OPTIONAL_CHILD (Array< Slur >, slurs)
	The slurs that start on this event.
	MNX_OPTIONAL_PROPERTY (int, staff)
	Staff number override (e.g., for cross-staff events.)
	MNX_OPTIONAL_PROPERTY (StemDirection, stemDirection)
	Forced stem direction.
std::optional< Note >	findNote (const std::string &noteId) const
	Finds a note in the event by its ID.
bool	isGrace () const
	Returns true if this event is part of a grace note sequence.
bool	isTremolo () const
	Returns true if this event is part of a multi-note tremolo sequence.
Sequence	getSequence () const
	Returns the Sequence instance for this event.
size_t	getSequenceIndex () const
	Returns the index of the event (or its container) in the Sequence instance for this event.
FractionValue	calcStartTime () const
	Calculates and returns the start time of this event within the measure.
Public Member Functions inherited from mnx::ContentObject
	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (std::string, type, std::string(ContentTypeValueDefault))
	determines our type in the JSON
template<typename T , std::enable_if_t< std::is_base_of_v< ContentObject, T >, int > = 0>
T	get () const
	Retrieve an element as a specific type.
template<typename T , std::enable_if_t< std::is_base_of_v< ContentObject, T >, int > = 0>
T	getTypedObject () const
	Constructs an object of type T if its type matches the JSON type.
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 object that owns the content 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.
void	setExtension (const std::string &key, const json &value)
	Sets a vendor extension value in _x, creating _x when needed.
std::optional< json >	getExtension (const std::string &key) const
	Gets a vendor extension value from _x.
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 , typename Scope = scope::Default>
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 ContentObject::container.)
json_pointer	pointer () const
	Returns the json_pointer for this node.
Document	document () const
	Returns the document root.

Static Public Member Functions
static Required	make (NoteValueBase base, unsigned dots=0)
	Create a Required instance for Event.

Static Public Attributes
static constexpr std::string_view	ContentTypeValue = ContentObject::ContentTypeValueDefault
	type value that identifies the type within the content array
static constexpr std::string_view	JsonSchemaTypeName = "event"
	required for mapping

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.
Static Protected Attributes inherited from mnx::ContentObject
static constexpr std::string_view	ContentTypeValueDefault = "event"
	default type value that identifies the type within the content array

Detailed Description

Represents a musical event within a sequence.

Constructor & Destructor Documentation

Event()

mnx::sequence::Event::Event ( Base &  parent, std::string_view  key, NoteValueBase  base, unsigned  dots = 0  )

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
base	The note value base for the event duration.
dots	Number of dots on the event duration.

Member Function Documentation

findNote()

std::optional< sequence::Note > mnx::sequence::Event::findNote

(

const std::string &

noteId

)

const

Finds a note in the event by its ID.

Parameters

noteId

The note ID to find

Returns

The note if found, otherwise std::nullopt;

getSequence()

Sequence mnx::sequence::Event::getSequence

(

)

const

Returns the Sequence instance for this event.

Exceptions

std::logic_error

if the json pointer does not contain a sequence (should be impossible)

getSequenceIndex()

size_t mnx::sequence::Event::getSequenceIndex

(

)

const

Returns the index of the event (or its container) in the Sequence instance for this event.

Exceptions

std::logic_error

if the json pointer does not contain a sequence (should be impossible)

MNX_OPTIONAL_CHILD() [1/2]

mnx::sequence::Event::MNX_OPTIONAL_CHILD	(	Array< Note >	,
		notes
	)

Note array

MNX_OPTIONAL_CHILD() [2/2]

mnx::sequence::Event::MNX_OPTIONAL_CHILD	(	Rest	,
		rest
	)

indicates this event is a rest.

Todo:

orient