corrected errors in DataSet classdef and help

nix
Pierre Alexandre Tremblay 4 years ago
parent fedaa68b45
commit edb1bc558f

@ -35,7 +35,7 @@ FluidDataSet : FluidDataObject
deletePointMsg{|identifier| ^this.prMakeMsg(\deletePoint,id,identifier.asSymbol);} deletePointMsg{|identifier| ^this.prMakeMsg(\deletePoint,id,identifier.asSymbol);}
deletePoint{|identifier, buffer, action| deletePoint{|identifier, action|
actions[\deletePoint] = [nil,action]; actions[\deletePoint] = [nil,action];
this.prSendMsg(this.deletePointMsg(identifier)); this.prSendMsg(this.deletePointMsg(identifier));
} }

@ -39,6 +39,8 @@ ARGUMENT:: identifier
The identifier for the point. The identifier for the point.
ARGUMENT:: buffer ARGUMENT:: buffer
A link::Classes/Buffer:: containing the data for the point. A link::Classes/Buffer:: containing the data for the point.
ARGUMENT:: action
A function to run when the operation completes.
METHOD:: getPoint METHOD:: getPoint
Retrieve a point from the data set into a link::Classes/Buffer::. If the identifier does not exist an error will be reported. Retrieve a point from the data set into a link::Classes/Buffer::. If the identifier does not exist an error will be reported.
@ -46,10 +48,15 @@ ARGUMENT:: identifier
The identifier for the point. The identifier for the point.
ARGUMENT:: buffer ARGUMENT:: buffer
A link::Classes/Buffer:: where the retrieved data will be stored. A link::Classes/Buffer:: where the retrieved data will be stored.
ARGUMENT:: action
A function to run when the operation completes.
METHOD:: deletePoint METHOD:: deletePoint
Remove a point from the data set. If the identifier doesn't exist an error will be reported. ARGUMENT:: identifier Remove a point from the data set. If the identifier doesn't exist an error will be reported.
ARGUMENT:: identifier
The identifier to be deleted. The identifier to be deleted.
ARGUMENT:: action
A function to run when the operation completes.
METHOD:: setPoint METHOD:: setPoint
Set the point. If the identifier exists, this method behaves like updatePoint. If the identifier doesn't exist, it behaves like addPoint. Set the point. If the identifier exists, this method behaves like updatePoint. If the identifier doesn't exist, it behaves like addPoint.
@ -57,46 +64,38 @@ ARGUMENT:: identifier
The identifier for the point. The identifier for the point.
ARGUMENT:: buffer ARGUMENT:: buffer
A link::Classes/Buffer:: containing the data for the point. A link::Classes/Buffer:: containing the data for the point.
ARGUMENT:: action
A function to run when the operation completes.
METHOD:: clear METHOD:: clear
Empty the data set. Empty the data set.
METHOD:: toBuffer METHOD:: toBuffer
Dump the content of the dataset to a link::Classes/Buffer::, with optional transposition, and a map of frames/channels to the original IDs as a link::Classes/FluidLabelSet::. Dump the content of the dataset to a link::Classes/Buffer::, with optional transposition, and a map of frames/channels to the original IDs as a link::Classes/FluidLabelSet::.
ARGUMENT:: buffer ARGUMENT:: buffer
The buffer to write to. It will be resized. The buffer to write to. It will be resized.
ARGUMENT:: transpose ARGUMENT:: transpose
If 0, each dataset point becomes a buffer frame, and each dataset dimension becomes a buffer channel. If 1, points become channels, and dimensions become frames. If 0, each dataset point becomes a buffer frame, and each dataset dimension becomes a buffer channel. If 1, points become channels, and dimensions become frames.
ARGUMENT:: labelSet ARGUMENT:: labelSet
The link::Classes/FluidLabelSet:: in which to dump the point's IDs associated with their reference frame number (or channel number if transposed). The link::Classes/FluidLabelSet:: in which to dump the point's IDs associated with their reference frame number (or channel number if transposed).
ARGUMENT:: action ARGUMENT:: action
A function to run when the dump is done. A function to run when the dump is done.
METHOD:: fromBuffer METHOD:: fromBuffer
Import to the dataset the content of a link::Classes/Buffer::, with optional transposition, and a map of frames/channels to the original IDs as a link::Classes/FluidLabelSet::. Import to the dataset the content of a link::Classes/Buffer::, with optional transposition, and a map of frames/channels to the original IDs as a link::Classes/FluidLabelSet::.
ARGUMENT:: buffer ARGUMENT:: buffer
The buffer to read from. The dataset will be resized. The buffer to read from. The dataset will be resized.
ARGUMENT:: transpose ARGUMENT:: transpose
If 0, each buffer frame becomes a dataset point, and each buffer channel becomes a dataset dimension. If 1, channels become points, and frames become dimensions. If 0, each buffer frame becomes a dataset point, and each buffer channel becomes a dataset dimension. If 1, channels become points, and frames become dimensions.
ARGUMENT:: labelSet ARGUMENT:: labelSet
The link::Classes/FluidLabelSet:: from which to retrieve the point's IDs associated with their reference frame number (or channel number if transposed). The link::Classes/FluidLabelSet:: from which to retrieve the point's IDs associated with their reference frame number (or channel number if transposed).
ARGUMENT:: action ARGUMENT:: action
A function to run when the import is done. A function to run when the import is done.
METHOD:: getIds METHOD:: getIds
Export to the dataset IDs to a link::Classes/FluidLabelSet::. Export to the dataset IDs to a link::Classes/FluidLabelSet::.
ARGUMENT:: labelSet ARGUMENT:: labelSet
The link::Classes/FluidLabelSet:: to export to. Its content will be replaced. The link::Classes/FluidLabelSet:: to export to. Its content will be replaced.
ARGUMENT:: action ARGUMENT:: action
A function to run when the export is done. A function to run when the export is done.

Loading…
Cancel
Save