lcoogan
/
flucoma-sc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

new interface for DataSet and LabelSet helpfiles

Browse Source
nix
Pierre Alexandre Tremblay 5 years ago
parent dc3157c5eb
commit f932628538
2 changed files with 3 additions and 25 deletions
Show Stats Download Patch File Download Diff File

17
release-packaging/HelpSource/Classes/FluidDataSet.schelp
Unescape Escape View File

@ -1,7 +1,7 @@
TITLE:: FluidDataSet TITLE:: FluidDataSet
summary:: Container for labelled, multidimensional data summary:: Container for labelled, multidimensional data
categories:: UGens>FluidManipulation categories:: UGens>FluidManipulation
related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKNN, Classes/FluidKMeans related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKMeans
​ ​
DESCRIPTION:: DESCRIPTION::
A server-side container associating labels with multi-dimensional data. FluidDataSet is identified by its name. A server-side container associating labels with multi-dimensional data. FluidDataSet is identified by its name.
@ -15,20 +15,10 @@ Create a new instance of the DataSet, with the given name. If a DataSet with thi
ARGUMENT:: server ARGUMENT:: server
The link::Classes/Server:: on which to create the data set. The link::Classes/Server:: on which to create the data set.
ARGUMENT:: name
A symbol with the name of the DataSet.
​ ​
returns:: The new instance returns:: The new instance
METHOD:: at
Retrieves a cached instance of a FluidDataSet with the given name, or returns nil if no such object exists.
ARGUMENT:: server
The server associated with this DataSet instance.
ARGUMENT:: name
The name of the DataSet to retrieve from the cache.
INSTANCEMETHODS:: INSTANCEMETHODS::
​ ​
PRIVATE:: init,id,cache PRIVATE:: init,id,cache
@ -63,9 +53,6 @@ Destroy the object on the server.
METHOD:: print METHOD:: print
Post an abbreviated content of the DataSet in the window by default, but you can supply a custom action instead. Post an abbreviated content of the DataSet in the window by default, but you can supply a custom action instead.
​​
METHOD:: synth
The internal synth the object uses to communicate with the server
returns:: A link::Classes/Synth:: returns:: A link::Classes/Synth::
​ ​

11
release-packaging/HelpSource/Classes/FluidLabelSet.schelp
Unescape Escape View File

@ -13,15 +13,6 @@ METHOD:: new
Make a new instance of a label set, uniquely identified by its name. Creating an instance with a name already in use will throw an exception. Use link::Classes/FluidLabelSet#*at:: or free the existing instance. Make a new instance of a label set, uniquely identified by its name. Creating an instance with a name already in use will throw an exception. Use link::Classes/FluidLabelSet#*at:: or free the existing instance.
ARGUMENT:: server ARGUMENT:: server
The link::Classes/Server:: on which to create the label set. The link::Classes/Server:: on which to create the label set.
ARGUMENT:: name
symbol with the label set's name.
METHOD:: at
Retrieve a label set from the cache.
ARGUMENT:: server
The link::Classes/Server:: on which to create the label set.
ARGUMENT:: name
symbol or string with the label set's name.
INSTANCEMETHODS:: INSTANCEMETHODS::
@ -30,7 +21,7 @@ PRIVATE:: init, id
METHOD:: addLabel METHOD:: addLabel
Add a label to the label set. Add a label to the label set.
ARGUMENT:: id ARGUMENT:: identifier
symbol or string with the ID for this label. symbol or string with the ID for this label.
ARGUMENT:: label ARGUMENT:: label
symbol or string with the label to add. symbol or string with the label to add.

Write Preview
Loading…
Cancel
Save