hep.aida
Interface ITupleColumn.String

All Superinterfaces:

IBaseTupleColumn, ITupleColumn

Enclosing interface:

ITupleColumn

public static interface ITupleColumn.String

extends ITupleColumn

/* Template Instantiated Interface: ITupleColumn

Nested Class Summary

Nested classes inherited from class 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

String	defaultValue() Get the column default value.
void	fill(String value) Fill the column.
String	fillableObject() Used when filling.
String	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

public void fill(String 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

public String value()

Get the object stored in the column at the current cursor's position.

Returns:

The object.

defaultValue

public String defaultValue()

Get the column default value.

Returns:

The column's default.

fillableObject

public String 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.