Package etomica.data.types

Class CastToDouble

java.lang.Object

etomica.data.DataProcessor

etomica.data.types.CastToDouble

All Implemented Interfaces:

DataPipe, IDataSink

public class CastToDouble
extends DataProcessor

A DataProcessor that converts a Data instance into a DataDouble. 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. Uses only first element of array.
• DataDouble. Does nothing, and returns input data directly.
• DataInteger. Performs a simple cast of the int to a double.
• DataGroup. Uses DataExtractor to locate a DataDouble in DataGroup. Other Data in group are discarded.

Attempts to cast other Data types will produce an IllegalArgumentException by processDataInfo.

Field Summary

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
CastToDouble()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
protected IData	processData(IData data)	Extracts a double from the input data and returns it encapsulated in a DataDouble.
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Prepares processor to handle Data.

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

CastToDouble

public CastToDouble()

Sole constructor.

Method Detail

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Prepares processor to handle Data. Uses given DataInfo to determine the type of Data to expect in subsequent calls to processData.

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 input Data type is not one of those described in the general class comments

processData

protected IData processData(IData data)

Extracts a double from the input data and returns it encapsulated in a DataDouble.

Specified by:

processData in class DataProcessor

Parameters:

data - a Data instance of the type indicated by the DataInfo at construction

Returns:

a DataDouble holding the value cast from the given Data; the same instance is returned with every invocation.

Throws:

java.lang.ClassCastException - if the given Data is not of the same type as indicated by the DataInfo given at construction