Package etomica.data

Interface IDataInfo

All Known Implementing Classes:

DataDouble.DataInfoDouble, DataDoubleArray.DataInfoDoubleArray, DataDoubleBDArray.DataInfoDoubleBDArray, DataFunction.DataInfoFunction, DataGroup.DataInfoGroup, DataInfo, DataTable.DataInfoTable, DataTensor.DataInfoTensor, DataVector.DataInfoVector

public interface IDataInfo

Method Summary

Modifier and Type	Method	Description
void	addTag(DataTag newTag)	Adds the tag to this IDataInfo object.
void	addTags(DataTag[] newTags)	Convenience method to add all of the given tags.
void	clearTags()	Removes all tags.
Dimension	getDimension()
IDataInfoFactory	getFactory()	Returns a mutable factory that can make copies of this instance of DataInfo.
java.lang.String	getLabel()
int	getLength()	Returns the number of numerical values held by the IData object.
DataTag[]	getTags()	Returns the array of tags held by this DataInfo instance.
IData	makeData()	Returns a Data object appropriate for this DataInfo instance.
java.lang.String	toString()	Returns "label (dimension)", where label and dimension are the values held by this instance.

Method Detail

getLabel

java.lang.String getLabel()

Returns:

Returns the descriptive label of the data, as given in constructor or at last call to setLabel.

toString

java.lang.String toString()

Returns "label (dimension)", where label and dimension are the values held by this instance.

Overrides:

toString in class java.lang.Object

getLength

int getLength()

Returns the number of numerical values held by the IData object.

makeData

IData makeData()

Returns a Data object appropriate for this DataInfo instance.

getDimension

Dimension getDimension()

Returns:

Returns the dimension given at construction.

addTag

void addTag(DataTag newTag)

Adds the tag to this IDataInfo object. You should only call this method if you created this IDataInfo (You should not call this for IDataInfo you receive. Make a new instance with the DataInfoFactory and then add your tag to that).

addTags

void addTags(DataTag[] newTags)

Convenience method to add all of the given tags. You should only call this method if you created this IDataInfo (You should not call this for IDataInfo you receive. Make a new instance with the DataInfoFactory and then add your tag to that).

clearTags

void clearTags()

Removes all tags. You should only call this method if you created this IDataInfo.

getTags

DataTag[] getTags()

Returns the array of tags held by this DataInfo instance. The same instance of the array can be returned each time the method is called, so the array elements should not be modified.

getFactory

IDataInfoFactory getFactory()

Returns a mutable factory that can make copies of this instance of DataInfo.