hep.aida.ref.histogram
Class DataPointSet

java.lang.Object
  |
  +--hep.aida.ref.event.AIDAObservable
        |
        +--hep.aida.ref.ManagedObject
              |
              +--hep.aida.ref.histogram.DataPointSet

All Implemented Interfaces:

hep.aida.IDataPointSet, hep.aida.dev.IDevManagedObject, hep.aida.IManagedObject, IsObservable

public class DataPointSet

extends ManagedObject

implements hep.aida.IDataPointSet, IsObservable

Basic user-level interface class for holding and managing a single set of "data points".

Author:

The AIDA team @ SLAC.

Field Summary

Fields inherited from class hep.aida.ref.ManagedObject

fillable

Fields inherited from class hep.aida.ref.event.AIDAObservable

isValid

Constructor Summary

protected	DataPointSet()
	DataPointSet(String name, String title, int dimOfPoints)
	DataPointSet(String name, String title, int dimOfPoints, int defaultCapacity)

Method Summary

hep.aida.IDataPoint	addPoint()
void	addPoint(hep.aida.IDataPoint point)
hep.aida.IAnnotation	annotation()
void	clear()
protected EventObject	createEvent()
int	dimension()
double	lowerExtent(int coord)
hep.aida.IDataPoint	point(int index)
void	removePoint(int index)
void	scale(double scaleFactor)
void	scaleErrors(double scaleFactor)
void	scaleValues(double scaleFactor)
void	setAnnotation(hep.aida.IAnnotation annotation)
void	setCoordinate(int coord, double[] values, double[] errors)
void	setCoordinate(int coord, double[] values, double[] errp, double[] errm)
protected void	setDimension(int dimOfPoints) Non-AIDA methods.
void	setPoint(int index, hep.aida.IDataPoint point) Set the IDataPoint at a give index in the set.
void	setTitle(String title)
int	size()
String	title()
double	upperExtent(int coord)

Methods inherited from class hep.aida.ref.ManagedObject

getAIDAType, isFillable, name, setFillable, setName

Methods inherited from class hep.aida.ref.event.AIDAObservable

addListener, fireStateChanged, fireStateChanged, removeListener, setIsValidAfterNotify, setValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hep.aida.ref.event.IsObservable

addListener, removeListener, setValid

Constructor Detail

DataPointSet

protected DataPointSet()

DataPointSet

public DataPointSet(String name,
                    String title,
                    int dimOfPoints)

DataPointSet

public DataPointSet(String name,
                    String title,
                    int dimOfPoints,
                    int defaultCapacity)

Method Detail

createEvent

protected EventObject createEvent()

Overrides:

createEvent in class AIDAObservable

annotation

public hep.aida.IAnnotation annotation()

Specified by:

annotation in interface hep.aida.IDataPointSet

setAnnotation

public void setAnnotation(hep.aida.IAnnotation annotation)

title

public String title()

Specified by:

title in interface hep.aida.IDataPointSet

setTitle

public void setTitle(String title)
              throws IllegalArgumentException

Specified by:

setTitle in interface hep.aida.IDataPointSet

IllegalArgumentException

dimension

public int dimension()

Specified by:

dimension in interface hep.aida.IDataPointSet

clear

public void clear()

Specified by:

clear in interface hep.aida.IDataPointSet

size

public int size()

Specified by:

size in interface hep.aida.IDataPointSet

point

public hep.aida.IDataPoint point(int index)

Specified by:

point in interface hep.aida.IDataPointSet

setPoint

public void setPoint(int index,
                     hep.aida.IDataPoint point)
              throws IllegalArgumentException

Set the IDataPoint at a give index in the set. This method is not in the IDataSet interface and is here for efficiency reasons

Parameters:

index - The IDataPoint index.

point - The corresponding IDataPoint to be set at the index

Throws:

IllegalArgumentException - If the index is < 0 or >= size().

addPoint

public hep.aida.IDataPoint addPoint()
                             throws RuntimeException

Specified by:

addPoint in interface hep.aida.IDataPointSet

RuntimeException

addPoint

public void addPoint(hep.aida.IDataPoint point)
              throws IllegalArgumentException

Specified by:

addPoint in interface hep.aida.IDataPointSet

IllegalArgumentException

removePoint

public void removePoint(int index)
                 throws IllegalArgumentException

Specified by:

removePoint in interface hep.aida.IDataPointSet

IllegalArgumentException

lowerExtent

public double lowerExtent(int coord)
                   throws IllegalArgumentException

Specified by:

lowerExtent in interface hep.aida.IDataPointSet

IllegalArgumentException

upperExtent

public double upperExtent(int coord)
                   throws IllegalArgumentException

Specified by:

upperExtent in interface hep.aida.IDataPointSet

IllegalArgumentException

scale

public void scale(double scaleFactor)
           throws IllegalArgumentException

Specified by:

scale in interface hep.aida.IDataPointSet

IllegalArgumentException

scaleValues

public void scaleValues(double scaleFactor)
                 throws IllegalArgumentException

Specified by:

scaleValues in interface hep.aida.IDataPointSet

IllegalArgumentException

scaleErrors

public void scaleErrors(double scaleFactor)
                 throws IllegalArgumentException

Specified by:

scaleErrors in interface hep.aida.IDataPointSet

IllegalArgumentException

setCoordinate

public void setCoordinate(int coord,
                          double[] values,
                          double[] errors)
                   throws IllegalArgumentException

Specified by:

setCoordinate in interface hep.aida.IDataPointSet

IllegalArgumentException

setCoordinate

public void setCoordinate(int coord,
                          double[] values,
                          double[] errp,
                          double[] errm)
                   throws IllegalArgumentException

Specified by:

setCoordinate in interface hep.aida.IDataPointSet

IllegalArgumentException

setDimension

protected void setDimension(int dimOfPoints)

Non-AIDA methods.