Package org.csstudio.opibuilder.script

Class ScriptData

java.lang.Object
org.csstudio.opibuilder.script.ScriptData
All Implemented Interfaces:
IAdaptable
Direct Known Subclasses:
RuleScriptData
public class ScriptData extends Object implements IAdaptable
The description data for a script.

  • Field Details

    • pvList

      protected List<PVTuple> pvList
      The input PVs of the script. Which can be accessed in the script and trigger the script execution.

  • Constructor Details

    • ScriptData

      public ScriptData()

    • ScriptData

      public ScriptData(IPath path)

  • Method Details

    • setPath

      public boolean setPath(IPath path)
      Set the script path.
      Parameters:
      path - the file path of the script.
      Returns:
      true if successful. false if the input is not a javascript file.

    • getPath

      public IPath getPath()
      Get the path of the script.

    • getPVList

      public List<PVTuple> getPVList()
      Get the input PVs of the script

    • addPV

      public void addPV(PVTuple pvTuple)

    • removePV

      public void removePV(PVTuple pvTuple)

    • setCheckConnectivity

      public void setCheckConnectivity(boolean checkConnectivity)

    • isCheckConnectivity

      public boolean isCheckConnectivity()

    • getCopy

      public ScriptData getCopy()

    • getAdapter

      public <T> T getAdapter(Class<T> adapter)
      Specified by:
      getAdapter in interface IAdaptable

    • setStopExecuteOnError

      public void setStopExecuteOnError(boolean stopExecuteOnError)
      Parameters:
      stopExecuteOnError - If true, stop to execute the script if error is detected in script.

    • isStopExecuteOnError

      public boolean isStopExecuteOnError()
      Returns:
      true if stop to execute the script if error is detected in script..

    • getScriptType

      public ScriptService.ScriptType getScriptType()

    • setScriptType

      public void setScriptType(ScriptService.ScriptType scriptType)

    • isEmbedded

      public boolean isEmbedded()

    • setEmbedded

      public void setEmbedded(boolean isEmbedded)

    • getScriptText

      public String getScriptText()

    • setScriptText

      public void setScriptText(String scriptText)

    • getScriptName

      public String getScriptName()

    • setScriptName

      public void setScriptName(String scriptName)