mnx::TimeSignature Class Reference

Represents the tempo for a global measure. More...

#include <CommonClasses.h>

Inheritance diagram for mnx::TimeSignature:

Classes
struct	Required
	initializer class for TimeSignature More...

Public Member Functions
	TimeSignature (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing NoteValue instances.
	TimeSignature (Base &parent, std::string_view key, int count, TimeSignatureUnit unit)
	Creates a new Barline class as a child of a JSON element.
	operator Required () const
	Implicit conversion back to Required.
	operator FractionValue () const
	Implicit converter to FractionValue. This function preserves the time signature values rather than reducing to lowest common denominator.
	MNX_REQUIRED_PROPERTY (int, count)
	the number of beats (top number)
	MNX_REQUIRED_PROPERTY (TimeSignatureUnit, unit)
	the unit value (bottom number)
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.
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.

Static Public Member Functions
static Required	make (int count, TimeSignatureUnit unit)
	Create a Required instance for TimeSignature.

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 the tempo for a global measure.

Constructor & Destructor Documentation

TimeSignature()

mnx::TimeSignature::TimeSignature ( Base &  parent, std::string_view  key, int  count, TimeSignatureUnit  unit  )

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
count	The number of beats (top number)
unit	The unit value (bottom number)