Package ffx.potential.commands

Class Timer

java.lang.Object

ffx.utilities.FFXCommand

ffx.potential.cli.PotentialCommand

ffx.potential.commands.Timer

public class Timer
extends PotentialCommand

The Timer command evaluates the wall clock time for energy and forces. Usage: ffxc Timer [options] <filename>

Field Summary

Fields inherited from class ffx.potential.cli.PotentialCommand

activeAssembly, baseDir, potentialFunctions

Fields inherited from class ffx.utilities.FFXCommand

args, binding, color, help, logger, parseResult, version

Constructor Summary

Constructors

Constructor	Description
Timer()
Timer(FFXBinding binding)
Timer(String[] args)

Method Summary

Modifier and Type	Method	Description
List<Potential>	getPotentials()	Returns a List of all Potential objects associated with this command.
Timer	run()	Execute this Command.

Methods inherited from class ffx.potential.cli.PotentialCommand

createOutputFile, destroyPotentials, getActiveAssemblies, getActiveAssembly, getActiveAssembly, getBaseDirString, getPotentialsFromAssemblies, init, parseFilePath, saveByExtension, saveByExtension, saveByOriginalExtension, saveByOriginalExtension, setActiveAssembly

Methods inherited from class ffx.utilities.FFXCommand

getCommand, helpString, listCommands, setBinding

Methods inherited from class java.lang.Object

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

Constructor Details

Timer

public Timer()

Timer

public Timer(FFXBinding binding)

Timer

public Timer(String[] args)

Method Details

run

public Timer run()

Description copied from class: FFXCommand

Execute this Command.

Overrides:

run in class FFXCommand

Returns:

The current FFXCommand.

getPotentials

public List<Potential> getPotentials()

Description copied from class: PotentialCommand

Returns a List of all Potential objects associated with this command. Should be written to tolerate nulls, as many tests run help() and exit without instantiating their Potentials.

Overrides:

getPotentials in class PotentialCommand

Returns:

All Potentials. Sometimes empty, never null.