edu.swri.swiftvis
Interface DataSource

All Superinterfaces:

GraphElement, java.io.Serializable

All Known Subinterfaces:

Filter

All Known Implementing Classes:

AbstractMultipleSourceFilter, AbstractSingleSourceFilter, AbstractSource, BinaryPositionData, BinnedFilter, CartAndRadSource, ClusterFilter, ConstantsFilter, CoordConvertFilter, CountRebinFilter, DiscardData, DumpSource, ElementTableEditor, EncounterData, Fixed2DBinnedSource, FunctionFilter, GeneralData, GroupNumberingFilter, InterpolatedSurfaceFilter, KeySelectionFilter, LinearFitFilter, LinearFitFilter.LinearFitSequenceFilter, MassFilter, MercurySource, MergeFilter, MovieFilter, Particle2DBinnedSource, RegionSelectionFilter, RotationFilter, SchemeFilter, SchemeSource, ScriptFilter, ScriptSource, SelectFilter, SequenceSource, SliceSelectionFilter, SortFilter, SPHSource, SyMBAMassFilter, ThinningFilter, WakePeakFilter

public interface DataSource
extends GraphElement

Method Summary

void	addOutput(DataSink sink)
DataElement	getElement(int i) Returns the specified data element for this source.
int	getNumElements() Returns the number of data elements that this source has in it.
int	getNumOutputs()
int	getNumParameters()
int	getNumValues()
DataSink	getOutput(int which)
java.lang.String	getParameterDescription(int which) Tells you what a particular parameter is used for.
java.lang.String	getValueDescription(int which) Tells you what a particular value is used for.
void	removeOutput(DataSink sink)

Methods inherited from interface edu.swri.swiftvis.GraphElement

clearData, copy, drawNode, getBounds, getDescription, getPropertiesPanel, redo, relink, translate

Method Detail

addOutput

void addOutput(DataSink sink)

removeOutput

void removeOutput(DataSink sink)

getNumOutputs

int getNumOutputs()

getOutput

DataSink getOutput(int which)

getNumElements

int getNumElements()

Returns the number of data elements that this source has in it. I'm using this instead of an iterator because direct access is much more efficient when trying to make tables of data.

Returns:

The number of data elements in this source.

getElement

DataElement getElement(int i)

Returns the specified data element for this source. I'm using this instead of an iterator because direct access is much more efficient when trying to make tables of data.

Parameters:

i - Which data element to return. Should be between 0 and getNumElements()-1.

Returns:

The selected element.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the provided index is out of bounds.

getNumParameters

int getNumParameters()

getParameterDescription

java.lang.String getParameterDescription(int which)

Tells you what a particular parameter is used for.

getNumValues

int getNumValues()

getValueDescription

java.lang.String getValueDescription(int which)

Tells you what a particular value is used for.