Package ffx.xray.commands
Class ComputeFc
java.lang.Object
ffx.utilities.FFXCommand
ffx.algorithms.cli.AlgorithmsCommand
ffx.xray.commands.ComputeFc
The X-ray ComputeFc script.
Usage:
ffxc xray.ComputeFc [options] <filename [file2...]>
Usage:
ffxc xray.ComputeFc [options] <filename [file2...]>
-
Field Summary
Fields inherited from class ffx.algorithms.cli.AlgorithmsCommand
activeAssembly, algorithmFunctions, algorithmListener, baseDir
Fields inherited from class ffx.utilities.FFXCommand
args, binding, color, help, logger, parseResult, version
-
Constructor Summary
ConstructorsConstructorDescriptionComputeFc constructor.ComputeFc
(FFXBinding binding) ComputeFc constructor.ComputeFc constructor that sets the command line arguments. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Reclaims resources associated with all Potential objects associated with this script.Returns a List of all Potential objects associated with this script.run()
Execute this Command.Methods inherited from class ffx.algorithms.cli.AlgorithmsCommand
getActiveAssemblies, getActiveAssembly, init, saveDirFile, setActiveAssembly, setBaseDir, updateTitle
Methods inherited from class ffx.utilities.FFXCommand
getCommand, helpString, listCommands, setBinding
-
Constructor Details
-
ComputeFc
public ComputeFc()ComputeFc constructor. -
ComputeFc
ComputeFc constructor that sets the command line arguments.- Parameters:
args
- Command line arguments.
-
ComputeFc
ComputeFc constructor.- Parameters:
binding
- The Binding to use.
-
-
Method Details
-
run
Description copied from class:FFXCommand
Execute this Command.- Overrides:
run
in classFFXCommand
- Returns:
- The current FFXCommand.
-
getPotentials
Description copied from class:AlgorithmsCommand
Returns a List of all Potential objects associated with this script.- Overrides:
getPotentials
in classAlgorithmsCommand
- Returns:
- All Potentials. Sometimes empty, never null.
-
destroyPotentials
public boolean destroyPotentials()Description copied from class:AlgorithmsCommand
Reclaims resources associated with all Potential objects associated with this script.- Overrides:
destroyPotentials
in classAlgorithmsCommand
- Returns:
- If all Potentials had resources reclaimed.
-