Package etomica.action

Class WriteConfiguration

java.lang.Object

etomica.action.WriteConfiguration

All Implemented Interfaces:

IAction

Direct Known Subclasses:

WriteConfigurationInterfacial, WriteConfigurationOriented

public class WriteConfiguration
extends java.lang.Object
implements IAction

Dumps a box's configuration to a file. The coordinates are written in a format that can be read in by ConfigurationFile. The output file has a "pos_new" extension, which should be renamed to "pos" for use with ConfigurationFile.

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected java.lang.String	confName
protected boolean	doApplyPBC
protected java.lang.String	fileName
protected Vector	writePosition

Constructor Summary

Constructors

Constructor	Description
WriteConfiguration(Space space)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed()	Writes the leaf Atom coordinates to the file confName.pos_new.
Box	getBox()	Returns the box whose atom coordinates get written to the file.
java.lang.String	getConfName()	Returns the configuration name.
boolean	getDoApplyPBC()	Returns true if PBC are applied to coordinates written to the file.
void	setBox(Box newBox)	Sets the box whose atom coordinates get written to the file.
void	setConfName(java.lang.String newConfName)	Sets the configuration name.
void	setDoApplyPBC(boolean newDoApplyPBC)	Directs the writer to apply periodic boundary conditions or not (true by default).
void	setFileName(java.lang.String newFileName)
protected void	writeAtom(java.io.FileWriter fileWriter, IAtom a)

Methods inherited from class java.lang.Object

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

Field Detail

confName

protected java.lang.String confName

fileName

protected java.lang.String fileName

box

protected Box box

doApplyPBC

protected boolean doApplyPBC

writePosition

protected final Vector writePosition

Constructor Detail

WriteConfiguration

public WriteConfiguration(Space space)

Method Detail

setConfName

public void setConfName(java.lang.String newConfName)

Sets the configuration name. The file written to is newConfName.pos_new

getConfName

public java.lang.String getConfName()

Returns the configuration name. The file written to is confName.pos_new

setFileName

public void setFileName(java.lang.String newFileName)

setBox

public void setBox(Box newBox)

Sets the box whose atom coordinates get written to the file.

getBox

public Box getBox()

Returns the box whose atom coordinates get written to the file.

setDoApplyPBC

public void setDoApplyPBC(boolean newDoApplyPBC)

Directs the writer to apply periodic boundary conditions or not (true by default).

getDoApplyPBC

public boolean getDoApplyPBC()

Returns true if PBC are applied to coordinates written to the file.

actionPerformed

public void actionPerformed()

Writes the leaf Atom coordinates to the file confName.pos_new. If the file exists, it is overwritten.

Specified by:

actionPerformed in interface IAction

writeAtom

protected void writeAtom(java.io.FileWriter fileWriter,
                         IAtom a)
                  throws java.io.IOException

Throws:

java.io.IOException