com.isti.jplotresp
Class AmpPhaseDataset

java.lang.Object
  extended by org.jfree.data.general.AbstractDataset
      extended by org.jfree.data.general.AbstractSeriesDataset
          extended by com.isti.jplotresp.AmpPhaseDataset
All Implemented Interfaces:
java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, org.jfree.data.general.Dataset, org.jfree.data.general.SeriesChangeListener, org.jfree.data.general.SeriesDataset, org.jfree.data.xy.XYDataset

public class AmpPhaseDataset
extends org.jfree.data.general.AbstractSeriesDataset
implements org.jfree.data.xy.XYDataset

Class AmpPhaseDataset is a JFreeChart dataset of amplitude or phase data points generated by JEvalResp. A single response or multiple responses may be represented, with amplitude or phase for each response.

See Also:
Serialized Form

Nested Class Summary
 class AmpPhaseDataset.AmpPhaseTooltipGenerator
          Class AmpPhaseTooltipGenerator defines a tooltip generator for the amplitude/phase dataset.
 
Field Summary
protected  boolean amplitudeSeriesFlag
           
protected  AmpPhaseDataset.AmpPhaseTooltipGenerator ampPhaseTooltipGeneratorObj
           
protected  double[] frequencyArray
           
protected  RespArraysInfo[] respArraysInfoArray
           
protected  int seriesCountValue
           
 
Constructor Summary
AmpPhaseDataset(double[] freqArr, AmpPhaseBlk[] ampPhaseBlkArr, boolean ampSeriesFlag)
          Constructs a dataset of amplitude and phase values for a response.
AmpPhaseDataset(RespArraysInfo[] rArrsInfoArr, boolean ampSeriesFlag)
          Constructs a dataset of amplitude or phase values for a response, including its individual stages.
 
Method Summary
 AmpPhaseDataset.AmpPhaseTooltipGenerator getAmpPhaseTooltipGeneratorObj()
          Returns the tooltip generator object for this dataset.
 org.jfree.data.DomainOrder getDomainOrder()
          Returns the order of the domain (or X) values returned by the dataset.
 int getItemCount(int series)
          Returns the number of items in the specified series.
 int getSeriesCount()
          Returns the number of series in the data source.
 java.lang.Comparable getSeriesKey(int series)
          Returns the name of the series.
 java.lang.String getTooltipStr(int series, int item)
          Returns a tooltip string for the given series and item.
 java.lang.Number getX(int series, int item)
          Returns the specified frequency value.
 double getXValue(int series, int item)
          Returns the specified frequency value.
 java.lang.Number getY(int series, int item)
          Returns the specified amplitude or phase value.
 double getYValue(int series, int item)
          Returns the specified amplitude or phase value.
 
Methods inherited from class org.jfree.data.general.AbstractSeriesDataset
indexOf, seriesChanged
 
Methods inherited from class org.jfree.data.general.AbstractDataset
addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.data.general.SeriesDataset
indexOf
 
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
 

Field Detail

respArraysInfoArray

protected final RespArraysInfo[] respArraysInfoArray

frequencyArray

protected final double[] frequencyArray

amplitudeSeriesFlag

protected final boolean amplitudeSeriesFlag

seriesCountValue

protected final int seriesCountValue

ampPhaseTooltipGeneratorObj

protected final AmpPhaseDataset.AmpPhaseTooltipGenerator ampPhaseTooltipGeneratorObj
Constructor Detail

AmpPhaseDataset

public AmpPhaseDataset(RespArraysInfo[] rArrsInfoArr,
                       boolean ampSeriesFlag)
Constructs a dataset of amplitude or phase values for a response, including its individual stages.

Parameters:
rArrsInfoArr - array of response-arrays/information objects.
ampSeriesFlag - true for amplitude series; false for phase series.

AmpPhaseDataset

public AmpPhaseDataset(double[] freqArr,
                       AmpPhaseBlk[] ampPhaseBlkArr,
                       boolean ampSeriesFlag)
Constructs a dataset of amplitude and phase values for a response.

Parameters:
freqArr - array of frequency values used to calculate the data.
ampPhaseBlkArr - array of JEvalResp 'AmpPhaseBlk' objects.
ampSeriesFlag - true for amplitude series; false for phase series.
Method Detail

getXValue

public double getXValue(int series,
                        int item)
Returns the specified frequency value.

Specified by:
getXValue in interface org.jfree.data.xy.XYDataset
Parameters:
series - index of the required series (not used).
item - index (zero-based) of the required item.
Returns:
A new 'Number' object holding the value.

getX

public java.lang.Number getX(int series,
                             int item)
Returns the specified frequency value.

Specified by:
getX in interface org.jfree.data.xy.XYDataset
Parameters:
series - index of the required series.
item - index (zero-based) of the required item.
Returns:
A new 'Number' object holding the value.

getYValue

public double getYValue(int series,
                        int item)
Returns the specified amplitude or phase value.

Specified by:
getYValue in interface org.jfree.data.xy.XYDataset
Parameters:
series - index of the required series.
item - index (zero-based) of the required item.
Returns:
A new 'Number' object holding the value.

getY

public java.lang.Number getY(int series,
                             int item)
Returns the specified amplitude or phase value.

Specified by:
getY in interface org.jfree.data.xy.XYDataset
Parameters:
series - index of the required series.
item - index (zero-based) of the required item.
Returns:
A new 'Number' object holding the value.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the data source.

Specified by:
getSeriesCount in interface org.jfree.data.general.SeriesDataset
Specified by:
getSeriesCount in class org.jfree.data.general.AbstractSeriesDataset
Returns:
The number of series in the data source.

getSeriesKey

public java.lang.Comparable getSeriesKey(int series)
Returns the name of the series.

Specified by:
getSeriesKey in interface org.jfree.data.general.SeriesDataset
Specified by:
getSeriesKey in class org.jfree.data.general.AbstractSeriesDataset
Parameters:
series - index (zero-based) of the series.
Returns:
The name of the series.

getItemCount

public int getItemCount(int series)
Returns the number of items in the specified series.

Specified by:
getItemCount in interface org.jfree.data.xy.XYDataset
Parameters:
series - index (zero-based) of the series (not used).
Returns:
The number of items in the specified series.

getDomainOrder

public org.jfree.data.DomainOrder getDomainOrder()
Returns the order of the domain (or X) values returned by the dataset.

Specified by:
getDomainOrder in interface org.jfree.data.xy.XYDataset
Returns:
The domain order (DomainOrder.ASCENDING).

getAmpPhaseTooltipGeneratorObj

public AmpPhaseDataset.AmpPhaseTooltipGenerator getAmpPhaseTooltipGeneratorObj()
Returns the tooltip generator object for this dataset.

Returns:
The 'AmpPhaseTooltipGenerator' object for this dataset.

getTooltipStr

public java.lang.String getTooltipStr(int series,
                                      int item)
Returns a tooltip string for the given series and item.

Parameters:
series - index of the required series.
item - index (zero-based) of the required item.
Returns:
A new tooltip string.