mnx::layout::StaffSource Class Reference

Represents a staff source for a staff in a layout in a score. More...

#include <Layout.h>

Inheritance diagram for mnx::layout::StaffSource:

Classes
struct	Required
	initializer class for StaffSource More...

Public Member Functions
	StaffSource (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing staff sources.
	StaffSource (Base &parent, std::string_view key, const std::string &partId)
	Creates a new StaffSource class as a child of a JSON element.
	operator Required () const
	Implicit conversion back to Required.
	MNX_OPTIONAL_PROPERTY (std::string, label)
	Text to appear to the left of the staff.
	MNX_OPTIONAL_PROPERTY (LabelRef, labelref)
	The labelref to use (rather than label)
	MNX_REQUIRED_PROPERTY (std::string, part)
	Id of the part to draw from.
	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (int, staff, 1)
	The staff number within the part.
	MNX_OPTIONAL_PROPERTY (StemDirection, stem)
	The stem direction for this staff source.
	MNX_OPTIONAL_PROPERTY (std::string, voice)
	The voice id to draw from.
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 object that owns the content array this element belongs to wrapped as the specified template type.
	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.
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 std::string &partId)
	Create a Required instance for StaffSource.

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 staff source for a staff in a layout in a score.

Constructor & Destructor Documentation

StaffSource()

mnx::layout::StaffSource::StaffSource ( Base &  parent, std::string_view  key, const std::string &  partId  )

inline

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

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
partId	The part to use as a source