StoredList | SuperCollider 3.14.0-dev Help

StoredList:

Filter:

Source: StoredList.sc

Description

A StoredList is typically used for storing settings to disk, and recalling them later. These are often parameter lists of processes like Ndefs, Pdefs, Tdefs. StoredList are used in PxChainPreset for now, and may be adapted for ProxyPreset as well.

First code examples:z = StoredList(\myTestID); // a storedList has these internal items: z.id.postcs; // this come from an ndef name z.list; // add two named settings: z.add(\base, [\amp, 0.25, \freq, 300]); z.add(\var1, [\amp, 0.50, \freq, 600]); // the current list z.list // or printed more readably z.prettyList // adding by an existing name replaces list at that name z.add(\base, [\amp, 0.25, \freq, 444]); z.add(\var1, [\amp, 0.50, \freq, 666]); z.prettyList // get names and values separately z.names z.values // access by index or name (or array) z.at(0) z.at(100) // nil outside index range z.at(\base); // by name z.at(\nope) // nil when unknown name z.at([\base, 1, \nope]); // also by array, also mixed z.removeAt(\otto); // nil z.removeAt(4); // nil z.removeAt(0) // removes base z.removeAt(\var1) z.list // empty now z.add(\base, [\amp, 0.25, \freq, 300]); z.add(\var1, [\amp, 0.50, \freq, 600]); /// storage to disk - by default, this is in Platform.userAppSupportDir z.write; // posts: StoredList('myTestID'): stored 2 settings at: "/Users/adc/Library/Application Support/SuperCollider/settings/myTestID.pxpreset.scd" z.filename z.dir z.storePath z.storePath.openOS // add more settings z.add(\base2, [\amp, 0.25, \freq, 444]); z.add(\var2, [\amp, 0.50, \freq, 666]); z.list.size; z.write; // the currently written settings: z.dir.openOS; // previous settings are always backed up here: z.backupDir.openOS; // a different storedList object with the same id // will read and store the same settings! y = StoredList(\myTestID); y.read; y.list; y.storePath == z.storePath y.prettyList;

Class Methods

StoredList.new(id, list, suffix: ".pxpreset")

create a new storedList object, with

Arguments:

id	a symbol as id
list	an optional list of associations
suffix	a suffix used for storing as file

Inherited class methods

Undocumented class methods

StoredList.boundsAround(loc, winSize, flip: true)

From extension in /home/stefan/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/scide_scqt/GUI/extStoredListDialogs.sc

StoredList.verbose

StoredList.verbose = value

Instance Methods

.id

the id of the storedList

.list

the list of stored settings

.names

.values

get names and values of stored settings separately

.prettyList

readable post of list, as also used for storage

.at(nameOrIndex)

Arguments:

nameOrIndex

access items in the list by name, index or array of names/indices

.add(name, setting)

add a setting to the list by name

.removeAt(name)

Arguments:

name	remoce a setting by name or index

.indexOf(name)

Arguments:

name	get index in list for given name

Storage

.addToDisk

.addToDisk = value

get and set flag whether to write changes to disk

.write(path)

write a setting to disk

Arguments:

path	an optional path - default is auto-created `storePath`.

.dir

the directory in which to write and read. consists of : dirpath +/+ dirname

.filename

the filename where settings list will be written and read. consists of : <id>.<suffix>.<fileExt>

.read(path, keep: false, doneFunc)

read settings list into the StoredList object.

Arguments:

path	(optional) path of stored file
keep	flag whether to append or clear list first
doneFunc	action to perform when read successfully

.storePath

dir +/+ filename

.backupDir

the directory where to put backups

.suffix

.suffix = value

a suffix to append to the filename.

.fileExt

.fileExt = value

the file extension to use for filename.

.local

tell a StoredList to store locally.

.backup(path)

Arguments:

path	move current stored file to backup folder; this happens automatically when saving.

.dirpath

.dirpath = value

.dirname

.dirname = value

the constituents of .dir

.deleteDialog(loc)

From extension in /home/stefan/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/scide_scqt/GUI/extStoredListDialogs.sc

open a dialog for deleting settings

.storeDialog(name, newset, loc)

From extension in /home/stefan/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/scide_scqt/GUI/extStoredListDialogs.sc

open a dialog for naming and storing a new setting

Inherited instance methods

Examples

helpfile source: /home/stefan/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/HelpSource/Classes/StoredList.schelp
link::Classes/StoredList::