Package etomica.interfacial

Class MeterWallPosition

java.lang.Object

etomica.data.DataSourceScalar

etomica.interfacial.MeterWallPosition

All Implemented Interfaces:

IDataSource

public class MeterWallPosition
extends DataSourceScalar

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected ISpecies	wallSpecies
protected double	zShift

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterWallPosition(Box box, ISpecies wallSpecies, double zShift)

Method Summary

Modifier and Type	Method	Description
double	getDataAsScalar()	Returns a single scalar value as the measurement for the given box.

Methods inherited from class etomica.data.DataSourceScalar

getData, getDataDouble, getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Field Detail

box

protected final Box box

wallSpecies

protected final ISpecies wallSpecies

zShift

protected final double zShift

Constructor Detail

MeterWallPosition

public MeterWallPosition(Box box,
                         ISpecies wallSpecies,
                         double zShift)

Method Detail

getDataAsScalar

public double getDataAsScalar()

Description copied from class: DataSourceScalar

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

Specified by:

getDataAsScalar in class DataSourceScalar