Package gda.jython.commands

Class ScannableCommands

java.lang.Object
gda.jython.commands.ScannableCommands
public class ScannableCommands extends Object
Holder for a series of static methods to operate Scannable objects

  • Field Details

    • GDA_POS_OVER_ALL_DISABLE

      public static final String GDA_POS_OVER_ALL_DISABLE
      Name of Property read by LocalPropties.check. If True then the pos command doesn't loop over every scannable
      See Also:

    • GDA_SCAN_SET_SCAN_PLOT_SETTINGS

      public static final String GDA_SCAN_SET_SCAN_PLOT_SETTINGS
      Name of Property read by LocalPropties.check. If True then the scanPlotSettings are set within the scan command
      See Also:

    • GDA_PLOT_SCAN_PLOT_SETTINGS_YAXES_INVISIBLE

      public static final String GDA_PLOT_SCAN_PLOT_SETTINGS_YAXES_INVISIBLE
      Name of Property read by LocalPropties.get. List of indices ( space separated) to scannable fields to be plotted not and made invisible
      See Also:

    • GDA_PLOT_SCAN_PLOT_SETTINGS_YAXES

      public static final String GDA_PLOT_SCAN_PLOT_SETTINGS_YAXES
      Name of Property read by LocalPropties.get. List of indices ( space separated) to scannable fields to be plotted
      See Also:

    • GDA_PLOT_SCAN_PLOT_SETTINGS_XAXIS

      public static final String GDA_PLOT_SCAN_PLOT_SETTINGS_XAXIS
      Name of Property read by LocalPropties.get. Index of scannable fields of scannables being scanned that is to be used as the x axis
      See Also:

    • GDA_PLOT_SCAN_PLOT_SETTINGS_FROM_USER_LIST

      public static final String GDA_PLOT_SCAN_PLOT_SETTINGS_FROM_USER_LIST
      Name of Property read by LocalPropties.check. If True the above indices are to the list of scannables as passed to the scan command. Else they are indices to the list of scannables when re-ordered to match the levels
      See Also:

    • GDA_PLOT_SCAN_PLOT_SETTINGS_SEPARATE_YAXES

      public static final String GDA_PLOT_SCAN_PLOT_SETTINGS_SEPARATE_YAXES
      Name of Property read by LocalPropties.check. If TRUE a separate YAxis is used for each visible to be plotted
      See Also:

  • Constructor Details

    • ScannableCommands

      public ScannableCommands()

  • Method Details

    • pos

      public static void pos(Scannable... scannables)

    • pos

      public static void pos(Object... args) throws Exception
      The pos command. Reports the current position of a scannable or moves one or more scannables concurrently. It prints the output to the terminal.
      Parameters:
      args -
      Throws:
      Exception - - any exception within this method

    • upos

      public static void upos(Object... args) throws Exception
      The pos command. Reports the current position of a scannable or moves one or more scannables concurrently.
      Parameters:
      args -
      Throws:
      Exception - - any exception within this method

    • getScannableNames

      public static List<String> getScannableNames()
      Gets a list of names of all the scannables on the server

    • pos

      public static void pos()
      prints to console all the scannables and their current position in the system

    • isPosCommandIsInTheProcessOfListingAllScannables

      public static boolean isPosCommandIsInTheProcessOfListingAllScannables()

    • inc

      public static void inc(Object... args) throws Exception
      Relative move version of pos. Prints the output to the terminal.
      Parameters:
      args -
      Throws:
      Exception

    • uinc

      public static void uinc(Object... args) throws Exception
      Relative move version of pos.
      Parameters:
      args -
      Throws:
      Exception

    • scan

      public static void scan(Object... args) throws Exception
      Sets up and operates a ConcurrentScan. The scan which should be used most of the time.
      Parameters:
      args -
      Throws:
      Exception

    • createConcurrentScan

      public static ConcurrentScan createConcurrentScan(Object... args) throws Exception
      Throws:
      Exception

    • createScanPlotSettings

      public static ScanPlotSettings createScanPlotSettings(ConcurrentScan theScan) throws Exception
      Parameters:
      theScan -
      Returns:
      ScanPlotSettings with Xaxis and YAxes based on several properties
      Throws:
      Exception

    • configureScanPipelineParameters

      public static void configureScanPipelineParameters(ScanBase scan)

    • pscan

      public static void pscan(Object... args) throws Exception
      Sets up and operates a PointsScan.
      Parameters:
      args -
      Throws:
      Exception

    • cscan

      public static void cscan(Object... args) throws Exception
      Sets up and operates a CentroidScan.
      Parameters:
      args -
      Throws:
      Exception

    • staticscan

      public static void staticscan(Scannable... args) throws Exception
      Sets up and operates a StaticScan.
      Parameters:
      args -
      Throws:
      Exception

    • gscan

      public static void gscan(Object... args) throws Exception
      Creates and runs a grid scan.

      I'm not sure how much this is used so I haven't included all GridScan constructors.

      Parameters:
      args -
      Throws:
      Exception

    • timescan

      public static void timescan(Object... args) throws Exception
      Time scan
      Parameters:
      args -
      Throws:
      Exception

    • tscan

      public static void tscan(Object... args) throws Exception
      Time scan
      Parameters:
      args -
      Throws:
      Exception

    • testscan

      public static void testscan(Object... args) throws Exception
      Sets up and operates a TestScan.
      Parameters:
      args -
      Throws:
      Exception

    • cv

      public static void cv(Object... args) throws Exception
      Creates a ContinuousScan object which is ready to be run.

      This command can be used within a 'scan' command so that a continuousscan can be used within a multi-dimension step scan.

      Parameters:
      args -
      Throws:
      Exception

    • level

      public static int level(Scannable scannable)
      Get the level of a single scannable

    • level

      public static void level(Scannable scannable, int level)
      Set the level of a single scannable

    • list_defaults

      public static void list_defaults()
      List all the Scannable objects used implicitly in every scan

    • get_defaults

      public static Collection<Scannable> get_defaults()

    • add_default

      public static void add_default(Scannable... args)
      Set a Scannable to be used by default

    • remove_default

      public static void remove_default(Scannable... args)
      Remove a Scannable from the list of defaults

    • clear_defaults

      public static void clear_defaults()
      Clear the list of default scannables

    • lastScanDataPoint

      public static IScanDataPoint lastScanDataPoint()