Loading...
Searching...
No Matches
mnx::part::PositionedClef Class Reference
Represents a positioned clef for the measure. More...
#include <Part.h>
Inheritance diagram for mnx::part::PositionedClef:
Public Member Functions | |
| PositionedClef (const std::shared_ptr< json > &root, json_pointer pointer) | |
| Constructor for existing PositionedClef instances. | |
| PositionedClef (Base &parent, const std::string_view &key, ClefSign clefSign, int staffPosition, std::optional< OttavaAmountOrZero > octaveAdjustment=std::nullopt) | |
| Creates a new PositionedClef class as a child of a JSON element. | |
| MNX_REQUIRED_CHILD (Clef, clef) | |
| the beats per minute of this tempo marking | |
| MNX_OPTIONAL_CHILD (RhythmicPosition, position) | |
| location within the measure of the tempo marking | |
| MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (int, staff, 1) | |
| the staff number (for multistaff parts) | |
| 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. | |
Detailed Description
Represents a positioned clef for the measure.
Constructor & Destructor Documentation
◆ PositionedClef()
|
inline |
Creates a new PositionedClef class as a child of a JSON element.
- Parameters
-
parent The parent class instance key The JSON key to use for embedding in parent. staffPosition The note value base for this Barline clefSign The type of clef symbold octaveAdjustment The number of octaves by which the clef transposes (may be omitted)
