mnx::RhythmicPosition Class Reference

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

#include <CommonClasses.h>

Inheritance diagram for mnx::RhythmicPosition:

Classes
struct	Required
	initializer class for RhythmicPosition More...

Public Member Functions
	RhythmicPosition (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing rhythmic position instances.
	RhythmicPosition (Base &parent, std::string_view key, const FractionValue &position)
	Creates a new RhythmicPosition class as a child of a JSON element.
	RhythmicPosition (const FractionValue &position)
	Creates a stand-alone RhythmicPosition instance unattached to any JSON document.
	operator Required () const
	Implicit conversion back to Required.
	MNX_REQUIRED_CHILD (Fraction, fraction,(const FractionValue &, value))
	The metric position, where 1/4 is a quarter note.
	MNX_OPTIONAL_PROPERTY (unsigned, graceIndex)
Public Member Functions inherited from mnx::Object
	Object ()
	Constructor fresh document or detached instance.
	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.
bool	empty () const
	Returns true if the object is empty.

Static Public Member Functions
static Required	make (const FractionValue &position)
	Create a Required instance for RhythmicPosition.
static int	compare (const RhythmicPosition &lhs, const RhythmicPosition &rhs, bool rhsIncludesTrailingGrace=false)
	Compare two rhythmic positions within the same measure.

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.

Detailed Description

Represents a system on a page in a score.

Constructor & Destructor Documentation

RhythmicPosition() [1/2]

mnx::RhythmicPosition::RhythmicPosition ( Base &  parent, std::string_view  key, const FractionValue &  position  )

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
position	The rhythmic position value to use.

RhythmicPosition() [2/2]

mnx::RhythmicPosition::RhythmicPosition ( const FractionValue &  position )

inline

Creates a stand-alone RhythmicPosition instance unattached to any JSON document.

Parameters

position

The rhythmic position value to use.

Member Function Documentation

compare()

int mnx::RhythmicPosition::compare ( const RhythmicPosition &  lhs, const RhythmicPosition &  rhs, bool  rhsIncludesTrailingGrace = false  )

static

Compare two rhythmic positions within the same measure.

Parameters

lhs	The left-hand position to compare.
rhs	The right-hand position to compare.
rhsIncludesTrailingGrace	When true, a right-hand position with graceIndex == 0 is treated as also including trailing grace notes at the same fractional position.

Returns

-1 if lhs is earlier, 1 if later, or 0 if equivalent for the requested policy.

MNX_OPTIONAL_PROPERTY()

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

The grace note index of this position. (0 is the primary, and then count to the left.)