Package org.scictrl.csshell.epics.server.application

Class ScanApplication

java.lang.Object
org.scictrl.csshell.epics.server.application.AbstractApplication
org.scictrl.csshell.epics.server.application.ScanApplication
All Implemented Interfaces:
Application, OnDemandValueProcessor.ValueProvider
public class ScanApplication extends AbstractApplication

ScanApplication class.

Author:
igor@scictrl.com

  • Field Details

  • Constructor Details

    • ScanApplication

      public ScanApplication()

      Constructor for ScanApplication.

  • Method Details

    • configure

      public void configure(String name, org.apache.commons.configuration.HierarchicalConfiguration config)
      Configures the internals of this application, provides reference to configuration with root inside applications tag. Server structure is not yet initialized, so does not have reference to Database, the Database reference will be available during activate call.
      Specified by:
      configure in interface Application
      Overrides:
      configure in class AbstractApplication
      Parameters:
      name - a String object
      config - configuration with room inside application tag.

    • notifyRecordWrite

      protected void notifyRecordWrite(String name)
      This method is called whenever record value has been written for any record, which belongs to this application (it was added to the application AbstractApplication.addRecord(String, Record)). Implementation class should override this method to intercept the update.
      Overrides:
      notifyRecordWrite in class AbstractApplication
      Parameters:
      name - the name of record, that triggered change.

    • notifyRecordChange

      protected void notifyRecordChange(String name, boolean alarmOnly)
      This method is called whenever record value changed for any record, which belongs to this application (it was added to the application AbstractApplication.addRecord(String, Record)). Implementation class should override this method to intercept the update.
      Overrides:
      notifyRecordChange in class AbstractApplication
      Parameters:
      name - the name of record, that triggered change.
      alarmOnly - if true then only alarm has been changed

    • activate

      public void activate()
      Application has now reference to Database. Application might want to connect to other records on this server or PVs on other servers. This can not be done until all records from configuration has been loaded. Call to this method signals application that records has been loaded and linking to other values can be commenced.
      Specified by:
      activate in interface Application
      Overrides:
      activate in class AbstractApplication

    • isConfigurable

      public boolean isConfigurable()

      isConfigurable.

      Returns:
      a boolean

    • isManualScan

      public boolean isManualScan()

      isManualScan.

      Returns:
      a boolean

    • setManualScan

      public void setManualScan(boolean interactive)

      Setter for the field manualScan.

      Parameters:
      interactive - a boolean

    • getStartValue

      public double getStartValue()

      getStartValue.

      Returns:
      a double

    • getEndValue

      public double getEndValue()

      getEndValue.

      Returns:
      a double

    • startManualScan

      public void startManualScan()

      startManualScan.

    • startManualScan

      public void startManualScan(ScanApplication.StartPoint sp)

      startManualScan.

      Parameters:
      sp - a ScanApplication.StartPoint object

    • getStepCount

      public int getStepCount()

      getStepCount.

      Returns:
      a int

    • stopManualScan

      public void stopManualScan()

      stopManualScan.

    • stepManualScan

      public boolean stepManualScan()

      stepManualScan.

      Returns:
      a boolean

    • stepManualScanInv

      public boolean stepManualScanInv()

      stepManualScanInv.

      Returns:
      a boolean

    • stepManualScan

      public boolean stepManualScan(boolean inc)

      stepManualScan.

      Parameters:
      inc - a boolean
      Returns:
      a boolean

    • isManualScanActive

      public boolean isManualScanActive()

      isManualScanActive.

      Returns:
      a boolean

    • getSetpoint

      public Record getSetpoint()

      getSetpoint.

      Returns:
      a Record object

    • getSetpointValue

      public double getSetpointValue()

      getSetpointValue.

      Returns:
      a double

    • getRateValue

      public double getRateValue()

      getRateValue.

      Returns:
      a double

    • isAtEnd

      public boolean isAtEnd()

      isAtEnd.

      Returns:
      a boolean

    • isAtStart

      public boolean isAtStart()

      isAtStart.

      Returns:
      a boolean