Loading...
Searching...
No Matches
mnx::part::Dynamic Class Reference
Represents a dynamic positioned with the next event in the sequence. More...
#include <Part.h>
Inheritance diagram for mnx::part::Dynamic:
Public Member Functions | |
| Dynamic (const std::shared_ptr< json > &root, json_pointer pointer) | |
| Constructor for existing Space objects. | |
| Dynamic (Base &parent, const std::string_view &key, const std::string &value, const Fraction::Initializer &position) | |
| Creates a new Space class as a child of a JSON element. | |
| MNX_OPTIONAL_PROPERTY (std::string, glyph) | |
| The SMuFL glyph name (if any) | |
| MNX_REQUIRED_CHILD (RhythmicPosition, position) | |
| The rhythmic position of the dynamic within the measure. | |
| MNX_OPTIONAL_PROPERTY (int, staff) | |
| The staff (within the part) this dynamic applies to. | |
| MNX_REQUIRED_PROPERTY (std::string, value) | |
| The value of the dynamic. Currently the MNX spec allows any string here. | |
| MNX_OPTIONAL_PROPERTY (std::string, voice) | |
| Optionally specify the voice this dynamic applies to. | |
| 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, const 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, 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. | |
| 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 dynamic positioned with the next event in the sequence.
Constructor & Destructor Documentation
◆ Dynamic()
|
inline |
Creates a new Space class as a child of a JSON element.
- Parameters
-
parent The parent class instance. key The JSON key to use for embedding in parent. value the value of the dynamic. Currently the spec allows any string here. position the position of the dynamic within the measure.
