Package etomica.data

Class DataSourceScalar

java.lang.Object

etomica.data.DataSourceScalar

All Implemented Interfaces:

IDataSource

Direct Known Subclasses:

AccumulatorHistory.DataSourceCount, DataSourceAcceptanceRatio, DataSourceAtomDistance, DataSourceAvgPressure, DataSourceAvgPressure2, DataSourceCountCollisions, DataSourceCountSteps, DataSourceCountTime, DataSourceMuRoot, DataSourceMuRoot.DataSourceMuRootDPressure, DataSourceMuRoot.DataSourceMuRootDU, DataSourceMuRoot.DataSourceMuRootPressure, DataSourceMuRoot.DataSourceMuRootVacancyConcentration, DataSourceMuRoot1, DataSourceMuRoot1.DataSourceMuRootPressure, DataSourceMuRoot1.DataSourceMuRootVacancyConcentration, DataSourceMuRootPMatch, DataSourceMuRootPMatch.DataSourceMuRootPressure, DataSourceMuRootPMatch.DataSourceMuRootVacancyConcentration, DataSourcePrevTime, DropletAtomicGraphic.DataSourceVaporDensity, InsertionGraphic.MeterWidom, MeterAPIPotentialEnergy, MeterAvgBondLength, MeterBoltzmannDirect, MeterContactRatio, MeterConversion, MeterDensity, MeterDensityCO, MeterDensityCO2, MeterDensityO2, MeterDensitySides, MeterDimerMoleFraction, MeterDipoleSumSquared1site, MeterDipoleSumSquaredTIP4PWater, MeterDirectInitPert, MeterDisplacementMoleculeRMS, MeterDisplacementRMS, MeterElongation, MeterEnd2End, MeterEndToEnd, MeterEnergy, MeterExcessAdsorbed, MeterFlux, MeterFlux, MeterFreeEnergy, MeterHarmonicCoordinate, MeterHarmonicEnergy, MeterHarmonicEnergyFromMove, MeterJacobian, MeterKineticEnergy, MeterKineticEnergyFromIntegrator, MeterKineticEnergyRigid, MeterLargestCluster, MeterLoad, MeterLocalDensity, MeterLocalMoleFraction, MeterMappedU, MeterMappedVirial, MeterMappedVirialV, MeterMaxExpansion, MeterMeanSquareDisplacement, MeterMoleculeTemperature, MeterMoleFraction, MeterNMolecules, MeterNormalStress, MeterOrientationOrderParameter, MeterPairedFraction, MeterPairSum, MeterPhiDeviation, MeterPotentialEnergy, MeterPotentialEnergyFromIntegrator, MeterPressure, MeterPressure2, MeterPressureCollisionCount, MeterPressureHard, MeterPressureMolecular, MeterPressureSuperBox, MeterRadiusGyration, MeterRmin, MeterRminSpecies, MeterRMSD, MeterRotPerturbMolecule, MeterSpin, MeterSpinMSquare, MeterStrain, MeterStress, MeterTemperature, MeterThetaDeviation, MeterViscosity, MeterVolume, MeterWallForce, MeterWallPosition, MeterWallPressure, MeterWidomInsertion, MeterWidomInsertionP, MultiharmonicGraphicMC.DataSourceBias, MultiharmonicGraphicMC.DataSourceChiSlope, MultiharmonicGraphicMC.DataSourceFE, MultiharmonicGraphicMC.DataSourceUa, MultiharmonicGraphicMC.DataSourceUa2, SimOverlapLJModule.MeterPotentialEnergyDifference

public abstract class DataSourceScalar
extends java.lang.Object
implements IDataSource

Particular data source for which the data is a simple scalar of type double.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataDouble	data
protected IDataInfo	dataInfo
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
DataSourceScalar(java.lang.String label, Dimension dimension)

Method Summary

Modifier and Type	Method	Description
IData	getData()
abstract double	getDataAsScalar()	Returns a single scalar value as the measurement for the given box.
DataDouble	getDataDouble()	Causes the single getDataAsScalar(Box) value to be computed and returned for the given box.
IDataInfo	getDataInfo()
DataTag	getTag()

Methods inherited from class java.lang.Object

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

Field Detail

data

protected final DataDouble data

dataInfo

protected final IDataInfo dataInfo

tag

protected final DataTag tag

Constructor Detail

DataSourceScalar

public DataSourceScalar(java.lang.String label,
                        Dimension dimension)

Method Detail

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

getTag

public DataTag getTag()

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

getDataAsScalar

public abstract double getDataAsScalar()

Returns a single scalar value as the measurement for the given box. Subclasses define this method to specify the measurement they make.

getDataDouble

public final DataDouble getDataDouble()

Causes the single getDataAsScalar(Box) value to be computed and returned for the given box. In response to a getData() call, MeterAbstract superclass will loop over all boxs previously specified via setBox and collect these values into a vector and return them in response to a getData() call.

getData

public final IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source