Package etomica.modules.chainequilibrium

Class MeterChainLength

java.lang.Object

etomica.modules.chainequilibrium.MeterChainLength

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<MeterChainLength.AtomTag>, DataSourceIndependent, IDataSource, java.io.Serializable

public class MeterChainLength
extends java.lang.Object
implements IDataSource, java.io.Serializable, AtomLeafAgentManager.AgentSource<MeterChainLength.AtomTag>, DataSourceIndependent

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MeterChainLength.AtomTag

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomLeafAgentManager<IAtom[]>	agentManager
protected Box	box
protected DataFunction	data
protected DataFunction.DataInfoFunction	dataInfo
protected AtomType	ignoredAtomType
protected DataTag	tag
protected AtomLeafAgentManager<MeterChainLength.AtomTag>	tagManager
protected DataDoubleArray	xData
protected DataDoubleArray.DataInfoDoubleArray	xDataInfo
protected DataTag	xTag

Constructor Summary

Constructors

Constructor	Description
MeterChainLength(AtomLeafAgentManager<IAtom[]> aam)

Method Summary

Modifier and Type	Method	Description
Box	getBox()
IData	getData()
IDataInfo	getDataInfo()
AtomType	getIgnoredAtomType()
int	getIndependentArrayDimension()	Returns the number of independent data dimensions
DataDoubleArray	getIndependentData(int i)	Returns the X data for the given dimension
DataDoubleArray.DataInfoDoubleArray	getIndependentDataInfo(int i)	Returns the DataInfo for the given dimension
DataTag	getIndependentTag()	Returns the tag associated with this DataSource.
DataTag	getTag()
MeterChainLength.AtomTag	makeAgent(IAtom a, Box agentBox)	Returns an agent for the given Atom.
protected int	recursiveTag(IAtom a)
void	releaseAgent(MeterChainLength.AtomTag agent, IAtom atom, Box agentBox)	This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements.
void	reset()
void	setBox(Box box)
void	setIgnoredAtomType(AtomType ignoredAtomType)
protected void	setupData(int maxChainLength)	Creates the data object (a DataFunction) to be returned by getData().

Methods inherited from class java.lang.Object

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

Field Detail

tag

protected final DataTag tag

xTag

protected final DataTag xTag

box

protected Box box

tagManager

protected AtomLeafAgentManager<MeterChainLength.AtomTag> tagManager

agentManager

protected AtomLeafAgentManager<IAtom[]> agentManager

data

protected DataFunction data

xData

protected DataDoubleArray xData

xDataInfo

protected DataDoubleArray.DataInfoDoubleArray xDataInfo

dataInfo

protected DataFunction.DataInfoFunction dataInfo

ignoredAtomType

protected AtomType ignoredAtomType

Constructor Detail

MeterChainLength

public MeterChainLength(AtomLeafAgentManager<IAtom[]> aam)

Method Detail

getTag

public DataTag getTag()

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

setupData

protected void setupData(int maxChainLength)

Creates the data object (a DataFunction) to be returned by getData(). data wraps the histogram's double[] so copying is not needed.

makeAgent

public MeterChainLength.AtomTag makeAgent(IAtom a,
                                          Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

Returns an agent for the given Atom. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

makeAgent in interface AtomLeafAgentManager.AgentSource<MeterChainLength.AtomTag>

agentBox - TODO

releaseAgent

public void releaseAgent(MeterChainLength.AtomTag agent,
                         IAtom atom,
                         Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

releaseAgent in interface AtomLeafAgentManager.AgentSource<MeterChainLength.AtomTag>

getData

public IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

reset

public void reset()

getIndependentDataInfo

public DataDoubleArray.DataInfoDoubleArray getIndependentDataInfo(int i)

Description copied from interface: DataSourceIndependent

Returns the DataInfo for the given dimension

Specified by:

getIndependentDataInfo in interface DataSourceIndependent

getIndependentData

public DataDoubleArray getIndependentData(int i)

Description copied from interface: DataSourceIndependent

Returns the X data for the given dimension

Specified by:

getIndependentData in interface DataSourceIndependent

getIndependentArrayDimension

public int getIndependentArrayDimension()

Description copied from interface: DataSourceIndependent

Returns the number of independent data dimensions

Specified by:

getIndependentArrayDimension in interface DataSourceIndependent

getIndependentTag

public DataTag getIndependentTag()

Description copied from interface: DataSourceIndependent

Returns the tag associated with this DataSource.

Specified by:

getIndependentTag in interface DataSourceIndependent

recursiveTag

protected int recursiveTag(IAtom a)

getBox

public Box getBox()

setBox

public void setBox(Box box)

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

getIgnoredAtomType

public AtomType getIgnoredAtomType()

setIgnoredAtomType

public void setIgnoredAtomType(AtomType ignoredAtomType)