Loading...
Searching...
No Matches
mnx::sequence::MultiNoteTremolo Class Reference
Represents a multi-note tremolo sequence within a sequence. More...
#include <Sequence.h>
Inheritance diagram for mnx::sequence::MultiNoteTremolo:
Public Member Functions | |
| MultiNoteTremolo (const std::shared_ptr< json > &root, json_pointer pointer) | |
| Constructor for existing Tuplet objects. | |
| MultiNoteTremolo (Base &parent, std::string_view key, int numberOfMarks, unsigned noteCount, const NoteValue::Initializer ¬eValue) | |
| Creates a new MultiNoteTremolo class as a child of a JSON element. | |
| MNX_REQUIRED_CHILD (ContentArray, content) | |
| array of events | |
| MNX_OPTIONAL_CHILD (NoteValue, individualDuration) | |
| optional value that specifies the individual duration of each event in the tremolo. | |
| MNX_REQUIRED_PROPERTY (int, marks) | |
| the number of marks (beams) | |
| MNX_REQUIRED_CHILD (NoteValueQuantity, outer) | |
| a half note tremolo would be 2 quarters here | |
| 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. | |
| 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, 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. | |
| 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. | |
Static Public Attributes | |
| static constexpr std::string_view | ContentTypeValue = "tremolo" |
| type value that identifies the type within the content array | |
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 multi-note tremolo sequence within a sequence.
Constructor & Destructor Documentation
◆ MultiNoteTremolo()
|
inline |
Creates a new MultiNoteTremolo class as a child of a JSON element.
- Parameters
-
parent The parent class instance key The JSON key to use for embedding in parent. numberOfMarks The number of marks (beams) in the tremolo noteCount The number of events in the tremolo (usually 2) noteValue The duration of each event in the tremolo (e.g., a half note tremolo would be 2 quarters here)
