FreeHEP API
Version current

hep.tuple.interfaces
Interface FTupleColumn

All Known Subinterfaces:
FillableTupleColumn
All Known Implementing Classes:
TupleColumn

public interface FTupleColumn

An interface implemented by all TupleColumns

Author:
The FreeHEP team @ SLAC.
Source Code:
FTupleColumn.java

Method Summary
 void defaultValue(Value value)
          Get the default value stored in the column.
 boolean hasDefaultValue()
          Check if the column has a default value.
 void maxValue(Value value)
          Get the maximum value stored in the column.
 void meanValue(Value value)
          Get the mean value stored in the column.
 void minValue(Value value)
          Get the minimum value stored in the column.
 String name()
          The name of che column.
 void rmsValue(Value value)
          Get the rms value stored in the column.
 Class type()
          The type of the column.
 

Method Detail

name

public String name()
The name of che column.

Returns:
The column's name.

type

public Class type()
The type of the column. If the column is a folder, i.e. and FTuple, its return type should either be FTuple.class or FillableTuple.class

Returns:
The column's type.

minValue

public void minValue(Value value)
Get the minimum value stored in the column.

Parameters:
value - The Value object in which the minimum value is passed.

maxValue

public void maxValue(Value value)
Get the maximum value stored in the column.

Parameters:
value - The Value object in which the maximum value is passed.

meanValue

public void meanValue(Value value)
Get the mean value stored in the column.

Parameters:
value - The Value object in which the mean value is passed.

rmsValue

public void rmsValue(Value value)
Get the rms value stored in the column.

Parameters:
value - The Value object in which the rms value is passed.

defaultValue

public void defaultValue(Value value)
Get the default value stored in the column.

Parameters:
value - The Value object in which che maximum value is passed.

hasDefaultValue

public boolean hasDefaultValue()
Check if the column has a default value.

Returns:
true if the column has a default value.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.