Package etomica.data.types

Class CastToDoubleArray

java.lang.Object

etomica.data.DataProcessor

etomica.data.types.CastToDoubleArray

All Implemented Interfaces:

DataPipe, IDataSink

public class CastToDoubleArray
extends DataProcessor

A DataProcessor that converts a Data instance into a DataDoubleArray. Copies an element of the input data to the DataDouble's encapsulated value and returns the DataDouble instance.

Casting for various types of Data is performed as follows:

• DataDoubleArray. Does nothing, and returns input data directly.
• DataDouble. Casts to a 1-element array.
• DataInteger. Casts to a 1-element array.
• DataVector. Casts to a one-dimensional array of length equal to the number of vector elements.
• DataTensor. Casts to a two-dimension square array.
• DataFunction. Casts only the dependent data, to an array of the same shape. Independent data are discarded.
• DataGroup. Uses DataExtractor to locate a DataDoubleArray in DataGroup. Other Data in group are discarded.

Attempts to process a different type will result in an IllegalArgumentException when encountered in the processDataInfo method.

Field Summary

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
CastToDoubleArray()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
protected IData	processData(IData data)	Copies input Data to a DataDoubleArray and returns it (the DataDataDoubleArray).
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Prepares processor to perform cast.

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, putData, putDataInfo, setDataSink

Methods inherited from class java.lang.Object

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

Constructor Detail

CastToDoubleArray

public CastToDoubleArray()

Sole constructor.

Method Detail

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Prepares processor to perform cast. Given DataInfo is examined to see what data type will be given to processor.

Specified by:

processDataInfo in class DataProcessor

Parameters:

inputDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

the DataInfo of the Data that will be output by this DataProcessor

Throws:

java.lang.IllegalArgumentException - if DataInfo is not one of the acceptable types, as described in general comments for this class

processData

protected IData processData(IData data)

Copies input Data to a DataDoubleArray and returns it (the DataDataDoubleArray).

Specified by:

processData in class DataProcessor

Parameters:

data - the Data for processing

Returns:

the processed Data, for sending downstream (if not null)

Throws:

java.lang.ClassCastException - if input Data is not of the type indicated by the most recent call to processDataInfo