XJ::Root Class Reference

#include <Root.h>

Public Member Functions
	Root (const std::string &name)
void	evaluate (const std::regex &pattern, const std::string &text)

Static Public Member Functions
static Root	of (const std::string &name)

Public Attributes
PitchClass	pitchClass
std::string	remainingText

Detailed Description

Root can be the root of a Chord, Key or Scale.

Constructor & Destructor Documentation

Root()

Root::Root ( const std::string &  name )

explicit

Parse root and remaining string, using regular expressions

Parameters

name	to parse root and remaining of

Member Function Documentation

evaluate()

void Root::evaluate	(	const std::regex &	pattern,
		const std::string &	text
	)

First group matching pattern in text, else null

Parameters

pattern	to in
text	to search

of()

Root Root::of ( const std::string &  name )

static

Instantiate a Root by name

XJ understands the root of a slash chord https://www.pivotaltracker.com/story/show/176728338

Parameters

name

of root

Returns

root

Member Data Documentation

pitchClass

PitchClass XJ::Root::pitchClass

remainingText

std::string XJ::Root::remainingText

---

The documentation for this class was generated from the following files:

• /home/runner/work/xjmusic/xjmusic/engine/include/xjmusic/music/Root.h
• /home/runner/work/xjmusic/xjmusic/engine/src/music/Root.cpp