Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

hep.aida
Interface ITupleColumn.Object

All Superinterfaces:
IBaseTupleColumn, ITupleColumn
All Known Implementing Classes:
AbstractTuple.AbstractTupleColumnFactory.ObjectTupleColumn, TupleColumn.TupleColumnObject
Enclosing interface:
ITupleColumn
public static interface ITupleColumn.Object
extends ITupleColumn

/* Template Instantiated Interface: ITupleColumn

Nested Class Summary
 
Nested classes/interfaces inherited from interface hep.aida.ITupleColumn
ITupleColumn.B, ITupleColumn.C, ITupleColumn.D, ITupleColumn.F, ITupleColumn.I, ITupleColumn.ITuple, ITupleColumn.L, ITupleColumn.Object, ITupleColumn.S, ITupleColumn.String, ITupleColumn.Z
 
Method Summary
 Object defaultValue()
          Get the column default value.
 void fill(Object value)
          Fill the column.
 Object fillableObject()
          Used when filling.
 Object value()
          Get the object stored in the column at the current cursor's position.
 
Methods inherited from interface hep.aida.IBaseTupleColumn
maximum, mean, minimum, name, rms, type
 

Method Detail

fill

void fill(Object value)
          throws IllegalArgumentException
Fill the column. If the value is a number with value NaN, the entry will be recorded but it will not contribue to the column's statistics.

Parameters:
value - The base type or object to fill with.
Throws:
IllegalArgumentException

value

Object value()
Get the object stored in the column at the current cursor's position.

Returns:
The object.

defaultValue

Object defaultValue()
Get the column default value.

Returns:
The column's default.

fillableObject

Object fillableObject()
Used when filling. This method returns a prebooked (in general empty) object. This is intended to help the filling of a tuple in case of dealing with complex objects. Reissuing the method after a ITuple::addRow may return the same object but reseted. This method may return zero in case the implementation don't have the necessary material to provide a prebooked object of any kind. In case the column contains tuples (T = ITuple), this methods returns an empty tuple booked according to what had been specified at creation of the main tuple. In case the tuple column is binded to a user variable (done through the bind method), this method returns the pointer passed to the bind method. The user must not delete the returned object.

Returns:
An object.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
jHepWork 3.2 © jWork.org