MNX Document Model
Loading...
Searching...
No Matches
mnx::RhythmicPosition Class Reference

Represents a system on a page in a score. More...

#include <CommonClasses.h>

+ Inheritance diagram for mnx::RhythmicPosition:

Public Member Functions

 RhythmicPosition (const std::shared_ptr< json > &root, json_pointer pointer)
 Constructor for existing rhythmic position instances.
 
 RhythmicPosition (Base &parent, const std::string_view &key, const Fraction::Initializer &position)
 Creates a new RhythmicPosition class as a child of a JSON element.
 
 MNX_REQUIRED_CHILD (Fraction, fraction)
 The metric position, where 1/4 is a quarter note.
 
 MNX_OPTIONAL_PROPERTY (unsigned, graceIndex)
 (0 is the primary, and then count to the left.)
 
- 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.
 
Baseoperator= (const Base &src)
 Copy assignment operator.
 
Baseoperator= (Base &&src)
 Move assignment operator.
 
std::string dump (int indents=-1)
 Dumps the branch to a string. Useful in debugging.
 
template<typename 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
jsonref () const
 Convert this node for retrieval.
 
jsonref ()
 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 >
getChild (const std::string_view &key) const
 Retrieves and validates a required child node.
 
template<typename 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 system on a page in a score.

Constructor & Destructor Documentation

◆ RhythmicPosition()

mnx::RhythmicPosition::RhythmicPosition ( Base parent,
const std::string_view &  key,
const Fraction::Initializer position 
)
inline

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

Parameters
parentThe parent class instance
keyThe JSON key to use for embedding in parent.
positionPosition within a measure (as a fraction of whole notes)

Member Function Documentation

◆ MNX_OPTIONAL_PROPERTY()

mnx::RhythmicPosition::MNX_OPTIONAL_PROPERTY ( unsigned  ,
graceIndex   
)

(0 is the primary, and then count to the left.)

The grace note index of this position.