#include <ContentEntityStore.h>

Public Member Functions
	ContentEntityStore ()

	ContentEntityStore (std::ifstream &input)

	ContentEntityStore (std::string &input)

std::optional< Project * >	getProject ()

std::optional< const ProgramVoiceTrack * >	getTrackOfEvent (const ProgramSequencePatternEvent *event)

std::optional< const ProgramVoice * >	getVoiceOfEvent (const ProgramSequencePatternEvent *event)

Instrument::Type	getInstrumentTypeOfEvent (const ProgramSequencePatternEvent *event)

bool	hasInstrumentsOfType (Instrument::Type type)

bool	hasInstrumentsOfMode (Instrument::Mode mode)

bool	hasInstrumentsOfTypeAndMode (Instrument::Type type, Instrument::Mode mode)

std::vector< int >	getAvailableOffsets (const ProgramSequenceBinding *sequenceBinding) const

std::set< const InstrumentAudio * >	getAudiosOfInstrument (const UUID &id) const

std::set< const InstrumentAudio * >	getAudiosOfInstrument (const Instrument *instrument) const

std::vector< const ProgramSequenceBinding * >	getBindingsOfSequence (const ProgramSequence *sequence) const

std::vector< const ProgramSequenceBinding * >	getBindingsOfSequence (const UUID &sequenceId) const

std::set< const ProgramSequenceBindingMeme * >	getSequenceBindingMemesOfProgram (const Program *program) const

std::set< const ProgramSequenceBindingMeme * >	getSequenceBindingMemesOfProgram (const UUID &programId) const

std::vector< const ProgramSequenceBinding * >	getBindingsAtOffsetOfProgram (const Program *program, int offset, bool includeNearest) const

std::vector< const ProgramSequenceBinding * >	getBindingsAtOffsetOfProgram (const UUID &programId, int offset, bool includeNearest) const

std::vector< const ProgramSequenceChord * >	getChordsOfSequence (const ProgramSequence *sequence) const

std::vector< const ProgramSequenceChord * >	getChordsOfSequence (const UUID &programSequenceId) const

std::vector< const ProgramSequencePatternEvent * >	getEventsOfPattern (const ProgramSequencePattern *pattern) const

std::vector< const ProgramSequencePatternEvent * >	getEventsOfPattern (const UUID &patternId) const

std::set< const ProgramSequencePattern * >	getPatternsOfSequenceAndVoice (const UUID &programSequenceId, const UUID &programVoiceId) const

std::set< const TemplateBinding * >	getBindingsOfTemplate (const UUID &templateId) const

std::set< const ProgramSequencePattern * >	getSequencePatternsOfProgram (const UUID &programId) const

std::set< const ProgramSequencePattern * >	getSequencePatternsOfProgram (const Program *program) const

std::vector< const ProgramSequencePatternEvent * >	getSequencePatternEventsOfProgram (const UUID &programId) const

std::vector< const ProgramSequencePatternEvent * >	getEventsOfTrack (const ProgramVoiceTrack *track) const

std::vector< const ProgramSequencePatternEvent * >	getEventsOfTrack (const UUID &trackId) const

std::vector< const ProgramSequencePatternEvent * >	getEventsOfPatternAndTrack (const ProgramSequencePattern pattern, const ProgramVoiceTrack track) const

std::vector< const ProgramSequencePatternEvent * >	getEventsOfPatternAndTrack (const UUID &patternId, const UUID &trackId) const

std::set< const InstrumentAudio * >	getAudiosOfInstrumentTypesAndModes (const std::set< Instrument::Type > &types, const std::set< Instrument::Mode > &modes) const

std::set< const InstrumentAudio * >	getAudiosOfInstrumentTypes (const std::set< Instrument::Type > &types) const

std::set< const Instrument * >	getInstrumentsOfType (const Instrument::Type &type) const

std::set< const Instrument * >	getInstrumentsOfTypesAndModes (const std::set< Instrument::Type > &types, const std::set< Instrument::Mode > &modes) const

std::set< const Instrument * >	getInstrumentsOfTypes (const std::set< Instrument::Type > &types) const

std::set< const InstrumentMeme * >	getMemesOfInstrument (const UUID &instrumentId) const

std::set< const Instrument * >	getInstrumentsOfLibrary (const Library *library) const

std::set< const Instrument * >	getInstrumentsOfLibrary (const UUID &libraryId) const

Instrument::Type	getInstrumentTypeOfAudio (const UUID &instrumentAudioId) const

std::set< const ProgramMeme * >	getMemesOfProgram (const UUID &programId) const

std::set< std::string >	getMemesAtBeginning (const Program *program) const

std::set< const ProgramSequenceBindingMeme * >	getMemesOfSequenceBinding (const ProgramSequenceBinding *programSequenceBinding) const

std::set< const ProgramSequenceBindingMeme * >	getMemesOfSequenceBinding (const UUID &programSequenceBindingId) const

UUID	getPatternIdOfEvent (const UUID &eventId)

std::set< const ProgramSequencePattern * >	getPatternsOfSequence (const ProgramSequence *sequence)

std::set< const ProgramSequencePattern * >	getPatternsOfSequence (const UUID &sequence)

std::set< const ProgramSequencePattern * >	getPatternsOfVoice (const ProgramVoice *voice) const

std::set< const ProgramSequencePattern * >	getPatternsOfVoice (const UUID &voiceId) const

std::set< const Program * >	getProgramsOfLibrary (const Library *library) const

std::set< const Program * >	getProgramsOfLibrary (const UUID &libraryId) const

std::set< const Program * >	getProgramsOfType (Program::Type type) const

std::optional< const ProgramSequence * >	getSequenceOfBinding (const ProgramSequenceBinding *sequenceBinding)

std::set< const ProgramSequence * >	getSequencesOfProgram (const UUID &programId) const

std::vector< const ProgramSequenceBinding * >	getSequenceBindingsOfProgram (const UUID &programId) const

std::vector< const ProgramSequenceChord * >	getSequenceChordsOfProgram (const UUID &programId) const

std::set< const ProgramSequenceChordVoicing * >	getSequenceChordVoicingsOfProgram (const UUID &programId) const

std::set< const ProgramVoiceTrack * >	getTracksOfProgram (const UUID &programId) const

std::set< const ProgramVoiceTrack * >	getTracksOfProgramType (Program::Type type) const

std::set< const ProgramVoiceTrack * >	getTracksOfVoice (const ProgramVoice *voice) const

std::set< const ProgramVoiceTrack * >	getTracksOfVoice (const UUID &voiceId) const

std::set< std::string >	getTrackNamesOfVoice (const ProgramVoice *voice) const

std::set< const ProgramSequenceChordVoicing * >	getVoicingsOfChord (const ProgramSequenceChord *chord) const

std::set< const ProgramSequenceChordVoicing * >	getVoicingsOfChord (const UUID &chordId) const

std::set< const ProgramSequenceChordVoicing * >	getVoicingsOfChordAndVoice (const ProgramSequenceChord chord, const ProgramVoice voice) const

std::set< const ProgramSequenceChordVoicing * >	getVoicingsOfChordAndVoice (const UUID &chordId, const UUID &voiceId) const

std::set< const ProgramVoice * >	getVoicesOfProgram (const Program *program) const

std::set< const ProgramVoice * >	getVoicesOfProgram (const UUID &programId) const

std::optional< const Template * >	getTemplateByIdentifier (const std::optional< std::string >::value_type &identifier)

std::optional< const Template * >	getFirstTemplate ()

MemeTaxonomy	getMemeTaxonomy ()

ContentEntityStore	forTemplate (const Template *tmpl)

void	clear ()

void	put (const ContentEntityStore *other)

std::string	toString ()

	~ContentEntityStore ()

Constructor & Destructor Documentation

◆ ContentEntityStore() [1/3]

ContentEntityStore::ContentEntityStore ( )

explicitdefault

Default constructor

◆ ContentEntityStore() [2/3]

ContentEntityStore::ContentEntityStore ( std::ifstream & input )

explicit

Deserialize a ContentEntityStore object from a JSON file

Parameters

input The JSON file to deserialize

Returns: The deserialized ContentEntityStore object

◆ ContentEntityStore() [3/3]

ContentEntityStore::ContentEntityStore ( std::string & input )

explicit

Deserialize a ContentEntityStore object from a JSON string

Parameters

input The JSON string to deserialize

Returns: The deserialized ContentEntityStore object

◆ ~ContentEntityStore()

ContentEntityStore::~ContentEntityStore ( )

default

Virtual destructor

Member Function Documentation

◆ clear()

void ContentEntityStore::clear ( )

Clear the content store

◆ forTemplate()

ContentEntityStore ContentEntityStore::forTemplate ( const Template * tmpl )

Get a new ContentEntityStore object for a specific template

Only include entities bound to the template
Only include entities in a published state (for entities with a state)

◆ getAudiosOfInstrument() [1/2]

std::set< const InstrumentAudio * > ContentEntityStore::getAudiosOfInstrument ( const Instrument * instrument ) const

Get all InstrumentAudios for a given Instrument

Parameters

instrument for which to get audios

Returns: audios for instrument

◆ getAudiosOfInstrument() [2/2]

std::set< const InstrumentAudio * > ContentEntityStore::getAudiosOfInstrument ( const UUID & id ) const

Get all Audios for a given instrument id

Parameters

id	of instrument for which to get audios

Returns: audios of instrument id

◆ getAudiosOfInstrumentTypes()

std::set< const InstrumentAudio * > ContentEntityStore::getAudiosOfInstrumentTypes ( const std::set< Instrument::Type > & types ) const

Get all instrument audios for the given instrument types

Parameters

types of instrument

Returns: all audios for instrument type

◆ getAudiosOfInstrumentTypesAndModes()

std::set< const InstrumentAudio * > ContentEntityStore::getAudiosOfInstrumentTypesAndModes	(	const std::set< Instrument::Type > &	types,
		const std::set< Instrument::Mode > &	modes
	)		const

Get all instrument audios for the given instrument types and modes

Parameters

types	of instrument
modes	of instrument

Returns: all audios for instrument type

◆ getAvailableOffsets()

std::vector< int > ContentEntityStore::getAvailableOffsets ( const ProgramSequenceBinding * sequenceBinding ) const

Get all available sequence pattern offsets of a given sequence, sorted of offset

Parameters

sequenceBinding for which to get available sequence pattern offsets

Returns: collection of available sequence pattern offsets

◆ getBindingsAtOffsetOfProgram() [1/2]

std::vector< const ProgramSequenceBinding * > ContentEntityStore::getBindingsAtOffsetOfProgram	(	const Program *	program,
		int	offset,
		bool	includeNearest
	)		const

Get sequence bindings at a specified offset. If the target offset is not found in the chosen Main Program, we'll find the nearest matching offset, and return all bindings at that offset.

Chain should always be able to determine main sequence binding offset https://www.pivotaltracker.com/story/show/177052278

Parameters

program	for which to get sequence bindings
offset	to get sequence bindings at
includeNearest	whether to include the nearest offset if the target offset is not found

Returns: sequence bindings at offset

◆ getBindingsAtOffsetOfProgram() [2/2]

std::vector< const ProgramSequenceBinding * > ContentEntityStore::getBindingsAtOffsetOfProgram	(	const UUID &	programId,
		int	offset,
		bool	includeNearest
	)		const

Get sequence bindings at a specified offset. If the target offset is not found in the chosen Main Program, we'll find the nearest matching offset, and return all bindings at that offset.

Chain should always be able to determine main sequence binding offset https://www.pivotaltracker.com/story/show/177052278

Parameters

programId	for which to get sequence bindings
offset	to get sequence bindings at
includeNearest	whether to include the nearest offset if the target offset is not found

Returns: sequence bindings at offset

◆ getBindingsOfSequence() [1/2]

std::vector< const ProgramSequenceBinding * > ContentEntityStore::getBindingsOfSequence ( const ProgramSequence * sequence ) const

Get the sequence bindings for a given sequence

Parameters

sequence for which to get bindings

Returns: bindings of sequence

◆ getBindingsOfSequence() [2/2]

std::vector< const ProgramSequenceBinding * > ContentEntityStore::getBindingsOfSequence ( const UUID & sequenceId ) const

Get the sequence bindings for a given sequence id

Parameters

sequenceId for which to get bindings

Returns: bindings of sequence

◆ getBindingsOfTemplate()

std::set< const TemplateBinding * > ContentEntityStore::getBindingsOfTemplate ( const UUID & templateId ) const

Get all bindings for the given template id

Returns: template bindings

◆ getChordsOfSequence() [1/2]

std::vector< const ProgramSequenceChord * > ContentEntityStore::getChordsOfSequence ( const ProgramSequence * sequence ) const

Get all ProgramSequenceChords for a given Sequence

Parameters

sequence for which to get chords

Returns: chords of sequence

◆ getChordsOfSequence() [2/2]

std::vector< const ProgramSequenceChord * > ContentEntityStore::getChordsOfSequence ( const UUID & programSequenceId ) const

Get all ProgramSequenceChords for a given Sequence

Parameters

programSequenceId for which to get chords

Returns: chords of sequence

◆ getEventsOfPattern() [1/2]

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getEventsOfPattern ( const ProgramSequencePattern * pattern ) const

Get events for a given program pattern, sorted of position

Parameters

pattern for which to get events

Returns: events for given program pattern

◆ getEventsOfPattern() [2/2]

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getEventsOfPattern ( const UUID & patternId ) const

Get events for a given program sequence pattern id, sorted of position

Parameters

patternId for which to get events

Returns: events for given pattern id

◆ getEventsOfPatternAndTrack() [1/2]

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getEventsOfPatternAndTrack	(	const ProgramSequencePattern *	pattern,
		const ProgramVoiceTrack *	track
	)		const

Get events for a given program pattern and track, sorted of position

Parameters

pattern	for which to get events
track	for which to get events

Returns: events for given program pattern

◆ getEventsOfPatternAndTrack() [2/2]

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getEventsOfPatternAndTrack	(	const UUID &	patternId,
		const UUID &	trackId
	)		const

Get events for a given program sequence pattern id and track id, sorted of position

Parameters

patternId	for which to get events
trackId	for which to get events

Returns: events for given pattern id

◆ getEventsOfTrack() [1/2]

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getEventsOfTrack ( const ProgramVoiceTrack * track ) const

Get events for a given program track, sorted of position

Parameters

track for which to get events

Returns: events for given program track

◆ getEventsOfTrack() [2/2]

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getEventsOfTrack ( const UUID & trackId ) const

Get events for a given program voice track id, sorted of position

Parameters

trackId for which to get events

Returns: events for given track id

◆ getFirstTemplate()

std::optional< const Template * > ContentEntityStore::getFirstTemplate ( )

Get the first template from the content

Returns: the template if any exist in the content

◆ getInstrumentsOfLibrary() [1/2]

std::set< const Instrument * > ContentEntityStore::getInstrumentsOfLibrary ( const Library * library ) const

Get a collection of all instruments of the given library

Parameters

library for which to get instruments

Returns: collection of instruments

◆ getInstrumentsOfLibrary() [2/2]

std::set< const Instrument * > ContentEntityStore::getInstrumentsOfLibrary ( const UUID & libraryId ) const

Get a collection of all instruments of the given library id

Parameters

libraryId for which to get instruments

Returns: collection of instruments

◆ getInstrumentsOfType()

std::set< const Instrument * > ContentEntityStore::getInstrumentsOfType ( const Instrument::Type & type ) const

Get a collection of all instruments of a particular type for ingest

Returns: collection of instruments

◆ getInstrumentsOfTypes()

std::set< const Instrument * > ContentEntityStore::getInstrumentsOfTypes ( const std::set< Instrument::Type > & types ) const

Get a collection of all instruments of particular types

Parameters

types of instrument; empty list is a wildcard

Returns: collection of instruments

◆ getInstrumentsOfTypesAndModes()

std::set< const Instrument * > ContentEntityStore::getInstrumentsOfTypesAndModes	(	const std::set< Instrument::Type > &	types,
		const std::set< Instrument::Mode > &	modes
	)		const

Get a collection of all instruments of particular types and modes

Parameters

types	of instrument; empty list is a wildcard
modes	of instrument; empty list is a wildcard

Returns: collection of instruments

◆ getInstrumentTypeOfAudio()

Instrument::Type ContentEntityStore::getInstrumentTypeOfAudio ( const UUID & instrumentAudioId ) const

Get the instrument type for the given audio id

Parameters

instrumentAudioId for which to get instrument type

Returns: instrument type

Exceptions

RuntimeException on failure

◆ getInstrumentTypeOfEvent()

Instrument::Type ContentEntityStore::getInstrumentTypeOfEvent ( const ProgramSequencePatternEvent * event )

Get the instrument type for the given event

Parameters

event for which to get instrument type

Returns: instrument type

◆ getMemesAtBeginning()

std::set< std::string > ContentEntityStore::getMemesAtBeginning ( const Program * program ) const

Get all memes for a given program at sequence binding offset 0

Returns: collection of sequence memes

◆ getMemesOfInstrument()

std::set< const InstrumentMeme * > ContentEntityStore::getMemesOfInstrument ( const UUID & instrumentId ) const

Get memes of instrument

Parameters

instrumentId for which to get memes

Returns: memes of instrument

◆ getMemesOfProgram()

std::set< const ProgramMeme * > ContentEntityStore::getMemesOfProgram ( const UUID & programId ) const

Get memes of program

Parameters

programId for which to get memes

Returns: memes of program

◆ getMemesOfSequenceBinding() [1/2]

std::set< const ProgramSequenceBindingMeme * > ContentEntityStore::getMemesOfSequenceBinding ( const ProgramSequenceBinding * programSequenceBinding ) const

Get all program sequence binding memes for program sequence binding

Parameters

programSequenceBinding for which to get memes

Returns: memes

◆ getMemesOfSequenceBinding() [2/2]

std::set< const ProgramSequenceBindingMeme * > ContentEntityStore::getMemesOfSequenceBinding ( const UUID & programSequenceBindingId ) const

Get all program sequence binding memes for program sequence binding

Parameters

programSequenceBindingId for which to get memes

Returns: memes

◆ getMemeTaxonomy()

MemeTaxonomy ContentEntityStore::getMemeTaxonomy ( )

Get meme taxonomy for the current template, if present, else empty meme taxonomy

◆ getPatternIdOfEvent()

UUID ContentEntityStore::getPatternIdOfEvent ( const UUID & eventId )

Get the pattern id for an event id

Parameters

eventId for which to get pattern

Returns: pattern id

◆ getPatternsOfSequence() [1/2]

std::set< const ProgramSequencePattern * > ContentEntityStore::getPatternsOfSequence ( const ProgramSequence * sequence )

Get all patterns for a sequence

Parameters

sequence for which to get patterns

Returns: patterns of sequence

◆ getPatternsOfSequence() [2/2]

std::set< const ProgramSequencePattern * > ContentEntityStore::getPatternsOfSequence ( const UUID & sequence )

Get all patterns for a sequence ID

Parameters

sequence for which to get patterns

Returns: patterns of sequence

◆ getPatternsOfSequenceAndVoice()

std::set< const ProgramSequencePattern * > ContentEntityStore::getPatternsOfSequenceAndVoice	(	const UUID &	programSequenceId,
		const UUID &	programVoiceId
	)		const

Get all ProgramSequencePatterns for a given sequence and voice

Returns: ProgramSequencePatterns for sequence and voice

◆ getPatternsOfVoice() [1/2]

std::set< const ProgramSequencePattern * > ContentEntityStore::getPatternsOfVoice ( const ProgramVoice * voice ) const

Get all patterns for a voice

Parameters

voice for which to get patterns

Returns: patterns of voice

◆ getPatternsOfVoice() [2/2]

std::set< const ProgramSequencePattern * > ContentEntityStore::getPatternsOfVoice ( const UUID & voiceId ) const

Get all patterns for a voice ID

Parameters

voiceId for which to get patterns

Returns: patterns of voice

◆ getProgramsOfLibrary() [1/2]

std::set< const Program * > ContentEntityStore::getProgramsOfLibrary ( const Library * library ) const

Get a collection of all programs of the given library

Parameters

library for which to get programs

Returns: collection of programs

◆ getProgramsOfLibrary() [2/2]

std::set< const Program * > ContentEntityStore::getProgramsOfLibrary ( const UUID & libraryId ) const

Get a collection of all programs of the given library id

Parameters

libraryId for which to get programs

Returns: collection of programs

◆ getProgramsOfType()

std::set< const Program * > ContentEntityStore::getProgramsOfType ( Program::Type type ) const

Get a collection of all sequences of a particular type for ingest

Returns: collection of sequences

◆ getProject()

std::optional< Project * > ContentEntityStore::getProject ( )

Get the Project (there should be only one)

Returns: The Project

◆ getSequenceBindingMemesOfProgram() [1/2]

std::set< const ProgramSequenceBindingMeme * > ContentEntityStore::getSequenceBindingMemesOfProgram ( const Program * program ) const

Get the sequence binding memes for a given program

Parameters

program for which to get sequence binding memes

Returns: sequence binding memes of program

◆ getSequenceBindingMemesOfProgram() [2/2]

std::set< const ProgramSequenceBindingMeme * > ContentEntityStore::getSequenceBindingMemesOfProgram ( const UUID & programId ) const

Get the sequence binding memes for a given program id

Parameters

programId for which to get sequence binding memes

Returns: sequence binding memes of program

◆ getSequenceBindingsOfProgram()

std::vector< const ProgramSequenceBinding * > ContentEntityStore::getSequenceBindingsOfProgram ( const UUID & programId ) const

Get all sequence bindings for the given program

Parameters

programId for which to get bindings

Returns: sequence bindings

◆ getSequenceChordsOfProgram()

std::vector< const ProgramSequenceChord * > ContentEntityStore::getSequenceChordsOfProgram ( const UUID & programId ) const

Get all ProgramSequenceChords

Returns: ProgramSequenceChords

◆ getSequenceChordVoicingsOfProgram()

std::set< const ProgramSequenceChordVoicing * > ContentEntityStore::getSequenceChordVoicingsOfProgram ( const UUID & programId ) const

Get program sequence chord voicings

Parameters

programId to get sequence chord voicings of

Returns: sequence chord voicings for program

◆ getSequenceOfBinding()

std::optional< const ProgramSequence * > ContentEntityStore::getSequenceOfBinding ( const ProgramSequenceBinding * sequenceBinding )

Get the program sequence for a given program sequence binding

Parameters

sequenceBinding for which to get program sequence

Returns: program sequence for the given program sequence binding

◆ getSequencePatternEventsOfProgram()

std::vector< const ProgramSequencePatternEvent * > ContentEntityStore::getSequencePatternEventsOfProgram ( const UUID & programId ) const

Get events for a given program

Parameters

programId for which to get events

Returns: events for given program

◆ getSequencePatternsOfProgram() [1/2]

std::set< const ProgramSequencePattern * > ContentEntityStore::getSequencePatternsOfProgram ( const Program * program ) const

Get patterns for a given program pattern, sorted of position

Parameters

program for which to get patterns

Returns: patterns for given program pattern

◆ getSequencePatternsOfProgram() [2/2]

std::set< const ProgramSequencePattern * > ContentEntityStore::getSequencePatternsOfProgram ( const UUID & programId ) const

Get patterns for a given program

Parameters

programId for which to get patterns

Returns: patterns for given program

◆ getSequencesOfProgram()

std::set< const ProgramSequence * > ContentEntityStore::getSequencesOfProgram ( const UUID & programId ) const

Get all ProgramSequences

Parameters

programId to search for sequences

Returns: ProgramSequences

◆ getTemplateByIdentifier()

std::optional< const Template * > ContentEntityStore::getTemplateByIdentifier ( const std::optional< std::string >::value_type & identifier )

Get a template by an "identifier" which is first the name, then the ship key, then the id

Parameters

identifier for which to get template

Returns: template if found

◆ getTrackNamesOfVoice()

std::set< std::string > ContentEntityStore::getTrackNamesOfVoice ( const ProgramVoice * voice ) const

Get all track names for a given program voice

Parameters

voice for which to get track names

Returns: names of tracks for the given voice

◆ getTrackOfEvent()

std::optional< const ProgramVoiceTrack * > ContentEntityStore::getTrackOfEvent ( const ProgramSequencePatternEvent * event )

Get Program track for a given program event

Parameters

event to get program track of

Returns: Program track for the given program event

◆ getTracksOfProgram()

std::set< const ProgramVoiceTrack * > ContentEntityStore::getTracksOfProgram ( const UUID & programId ) const

Get all program voice tracks for the given program id

Parameters

programId for which to get tracks

Returns: tracks for program

◆ getTracksOfProgramType()

std::set< const ProgramVoiceTrack * > ContentEntityStore::getTracksOfProgramType ( Program::Type type ) const

Get all program voice tracks for the given program type

Parameters

type	of program

Returns: all voice tracks for program type

◆ getTracksOfVoice() [1/2]

std::set< const ProgramVoiceTrack * > ContentEntityStore::getTracksOfVoice ( const ProgramVoice * voice ) const

Get all Program Voice Tracks for the given Voice

Parameters

voice for which to get tracks

Returns: tracks for voice

◆ getTracksOfVoice() [2/2]

std::set< const ProgramVoiceTrack * > ContentEntityStore::getTracksOfVoice ( const UUID & voiceId ) const

Get all Program Voice Tracks for the given Voice ID

Parameters

voiceId for which to get tracks

Returns: tracks for voice

◆ getVoiceOfEvent()

std::optional< const ProgramVoice * > ContentEntityStore::getVoiceOfEvent ( const ProgramSequencePatternEvent * event )

Get Program voice for a given program event

Parameters

event to get program voice of

Returns: Program voice for the given program event

◆ getVoicesOfProgram() [1/2]

std::set< const ProgramVoice * > ContentEntityStore::getVoicesOfProgram ( const Program * program ) const

Get all program voices for a given program

Parameters

program for which to get program voices

Returns: program voices for the given program

◆ getVoicesOfProgram() [2/2]

std::set< const ProgramVoice * > ContentEntityStore::getVoicesOfProgram ( const UUID & programId ) const

Get all program voices for a given program

Parameters

programId for which to get program voices

Returns: program voices for the given program

◆ getVoicingsOfChord() [1/2]

std::set< const ProgramSequenceChordVoicing * > ContentEntityStore::getVoicingsOfChord ( const ProgramSequenceChord * chord ) const

Get all ProgramSequenceChordVoicings for a given Sequence Chord

Parameters

chord for which to get voicings

Returns: chords of sequence

◆ getVoicingsOfChord() [2/2]

std::set< const ProgramSequenceChordVoicing * > ContentEntityStore::getVoicingsOfChord ( const UUID & chordId ) const

Get all ProgramSequenceChordVoicings for a given Sequence Chord ID

Parameters

chordId for which to get voicings

Returns: chords of sequence

◆ getVoicingsOfChordAndVoice() [1/2]

std::set< const ProgramSequenceChordVoicing * > ContentEntityStore::getVoicingsOfChordAndVoice	(	const ProgramSequenceChord *	chord,
		const ProgramVoice *	voice
	)		const

Get all ProgramSequenceChordVoicings for a given Sequence Chord ID and Voice ID

Parameters

chord	for which to get voicings
voice	for which to get voicings

Returns: chords of sequence

◆ getVoicingsOfChordAndVoice() [2/2]

std::set< const ProgramSequenceChordVoicing * > ContentEntityStore::getVoicingsOfChordAndVoice	(	const UUID &	chordId,
		const UUID &	voiceId
	)		const

Get all ProgramSequenceChordVoicings for a given Sequence Chord ID and Voice ID

Parameters

chordId	for which to get voicings
voiceId	for which to get voicings

Returns: chords of sequence

◆ hasInstrumentsOfMode()

bool ContentEntityStore::hasInstrumentsOfMode ( Instrument::Mode mode )

Whether the content contains instruments of the given mode

Parameters

mode	of instrument for which to search

Returns: true if present

◆ hasInstrumentsOfType()

bool ContentEntityStore::hasInstrumentsOfType ( Instrument::Type type )

Whether the content contains instruments of the given type

Parameters

type	of instrument for which to search

Returns: true if present

◆ hasInstrumentsOfTypeAndMode()

bool ContentEntityStore::hasInstrumentsOfTypeAndMode	(	Instrument::Type	type,
		Instrument::Mode	mode
	)

Whether the content contains instruments of the given type

Parameters

type	of instrument for which to search
mode	of instrument for which to search

Returns: true if present

◆ put()

void ContentEntityStore::put ( const ContentEntityStore * other )

Put all the content from another ContentEntityStore

◆ toString()

std::string ContentEntityStore::toString ( )

Summarize the contents of the store as a string

Returns: string formatted summary of content in the store

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

/home/runner/work/xjmusic/xjmusic/engine/include/xjmusic/content/ContentEntityStore.h
/home/runner/work/xjmusic/xjmusic/engine/src/content/ContentEntityStore.cpp

Public Member Functions

Constructor & Destructor Documentation

◆ ContentEntityStore() [1/3]

◆ ContentEntityStore() [2/3]

◆ ContentEntityStore() [3/3]

◆ ~ContentEntityStore()

Member Function Documentation

◆ clear()

◆ forTemplate()

◆ getAudiosOfInstrument() [1/2]

◆ getAudiosOfInstrument() [2/2]

◆ getAudiosOfInstrumentTypes()

◆ getAudiosOfInstrumentTypesAndModes()

◆ getAvailableOffsets()

◆ getBindingsAtOffsetOfProgram() [1/2]

◆ getBindingsAtOffsetOfProgram() [2/2]

◆ getBindingsOfSequence() [1/2]

◆ getBindingsOfSequence() [2/2]

◆ getBindingsOfTemplate()

◆ getChordsOfSequence() [1/2]

◆ getChordsOfSequence() [2/2]

◆ getEventsOfPattern() [1/2]

◆ getEventsOfPattern() [2/2]

◆ getEventsOfPatternAndTrack() [1/2]

◆ getEventsOfPatternAndTrack() [2/2]

◆ getEventsOfTrack() [1/2]

◆ getEventsOfTrack() [2/2]

◆ getFirstTemplate()

◆ getInstrumentsOfLibrary() [1/2]

◆ getInstrumentsOfLibrary() [2/2]

◆ getInstrumentsOfType()

◆ getInstrumentsOfTypes()

◆ getInstrumentsOfTypesAndModes()

◆ getInstrumentTypeOfAudio()

◆ getInstrumentTypeOfEvent()

◆ getMemesAtBeginning()

◆ getMemesOfInstrument()

◆ getMemesOfProgram()

◆ getMemesOfSequenceBinding() [1/2]

◆ getMemesOfSequenceBinding() [2/2]

◆ getMemeTaxonomy()

◆ getPatternIdOfEvent()

◆ getPatternsOfSequence() [1/2]

◆ getPatternsOfSequence() [2/2]

◆ getPatternsOfSequenceAndVoice()

◆ getPatternsOfVoice() [1/2]

◆ getPatternsOfVoice() [2/2]

◆ getProgramsOfLibrary() [1/2]

◆ getProgramsOfLibrary() [2/2]

◆ getProgramsOfType()

◆ getProject()

◆ getSequenceBindingMemesOfProgram() [1/2]

◆ getSequenceBindingMemesOfProgram() [2/2]

◆ getSequenceBindingsOfProgram()

◆ getSequenceChordsOfProgram()

◆ getSequenceChordVoicingsOfProgram()

◆ getSequenceOfBinding()

◆ getSequencePatternEventsOfProgram()

◆ getSequencePatternsOfProgram() [1/2]

◆ getSequencePatternsOfProgram() [2/2]

◆ getSequencesOfProgram()

◆ getTemplateByIdentifier()

◆ getTrackNamesOfVoice()

◆ getTrackOfEvent()

◆ getTracksOfProgram()

◆ getTracksOfProgramType()

◆ getTracksOfVoice() [1/2]

◆ getTracksOfVoice() [2/2]

◆ getVoiceOfEvent()

◆ getVoicesOfProgram() [1/2]

◆ getVoicesOfProgram() [2/2]

◆ getVoicingsOfChord() [1/2]

◆ getVoicingsOfChord() [2/2]

◆ getVoicingsOfChordAndVoice() [1/2]

◆ getVoicingsOfChordAndVoice() [2/2]

◆ hasInstrumentsOfMode()

◆ hasInstrumentsOfType()

◆ hasInstrumentsOfTypeAndMode()

◆ put()

◆ toString()