2.11 sddscasr

• description: sddscasr is an alternative version of casave and carestore. sddscasr is more efficient and has more features than casave/carestore. It can save and restore configurations in one program.
• examples: Save a snapshot of APS storage ring:
  sddscasr SR.req SR.snapshot -save -pendIOTime=100

  Restore a snapshot:

  sddscasr snapshot -restore -pendIOTime=100

  save snapshot with daemon mode, the output file in following command is out1-¡current date and time¿. Whenever the value of casavePV (oag:casave) is changed to 1, a new saving starts and data is written to a new output file with rootname of out1. (var1 is the input file contains PVs to be read)

  sddscasr var1 out1 -runControlPV=string=oag:ControlLawRC  
  -runControlDescription=string=test -daemon -dailyFiles -save -pidFile=pidFile  
  -casavePV=oag:casave -logFile=logFile &

• synopsis:
  usage: sddscasr <inputFile> <outputRoot> [-verbose]  
      [-daemon] [-dailyFiles] [-semaphore=<filename>] [-save] [-restore[=verify]] [-logFile=<filename>]  
      [-runControlPV={string=<string>|parameter=<string>},pingTimeout=<value>,pingInterval=<value>]  
      [-runControlDescription={string=<string>|parameter=<string>}] [-unique]  
      [-outputFilePV=<pvname>] [-inputFilePV=<pvname>] [-add] [-dryRun]  
      [-pidFile=<pidFile>] [-casavePV=<string>] [-interval=<seconds>] [-pendIOTime=<seconds>]  
      [-pipe=[input|output]]  
      [-waveform=[rootname=<string>][,extension=<string>][,directory=<string>][,onefile]  
        [,saveWaveformFile[,fullname]]]  
      [-numerical] [-description=<string>|pv=<pvname>]

• files:
  • input file:

    The input file is an SDDS file with a string column. For saving snapshot, the input file contains at least one string column - ControlName. For restoring snapshot, the input file contains at least two string columns - ControlName and ValueString, where ValueString is the value of the PVs to be restored.

  • output file:

    The output file only exists for saving snapshot. The output file contains everything in the input file, except that the ValueString column (if the input file has ValueString column) is update. And three more columns are created if they do not exist in the input file and their values are updated.

    • ValueString: the values of the PVs given in the input file.
    • IndirectName: its value is - for scalar PV or PVname for waveform PV.
    • CAError: its value is y if error occurred during channel access for corresponding PV or n if no error occurs.
• switches:
  • inputFile — input file name (SDDS file).
  • outputRoot — output file or root if -dailyFiles option is specified.
  • pipe[=input][,output] — The standard SDDS Toolkit pipe option. -dailyFiles option is ignored if -pipe=out or -pipe option is present.
  • semaphore — specify the flag file for indicating CA connection completion; the current output file name is written to the semaphore file.
  • daemon — run in daemon mode, staying in the background until a terminating signal is received.
  • dailyFiles — append the current date to the output file name.
  • save — read the values of PVs given in the input file and write to the output file.
  • restore[=verify] — set the values of process variables given in the input file. -save and -restore cannot be given at the same time.
  • add — with -restore, set PVs to current value plus provided value.
  • dryRun — with -restore, show PV values that would be set without changing them.
  • logFile — file for logging the printout information.
  • pidFile — file to which the PID is written.
  • interval — interval (in seconds) for checking the monitor PV or sleeping if no signal arrives.
  • pendIOTime — maximum time to wait for connections and return values.
  • casavePV — a monitor PV to turn on/off sddscasr. When set to 1, a save or restore is made and the PV is reset to 0.
  • outputFilePV — a character-waveform PV to store the output file name with full path.
  • inputFilePV — a character-waveform PV containing the input file name with full path.
  • unique — remove all duplicates but the first occurrence of each PV from the input file to prevent channel access errors when setting PV values.
  • description — specify SnapshotDescription parameter of the output file or provide a PV using pv=<pvname>.
  • runControlPV=string=<string>|parameter=<string>[,pingTimeout=<value>,pingInterval=<value>] — specifies the run control PV record.
  • runControlDescription — specifies a string parameter whose value is a run control PV description record.
  • numerical — return a numerical string value rather than a string for enumerated types.
  • waveform=rootname=<string>[,extension=<string>][,directory=<string>][,onefile]
    [,saveWaveformFile][,fullname] — provide the waveform rootname and directory for the restore option. By default, the directory is pwd and the rootname is the SnapshotFilename parameter in the input file.
  • verbose — print out messages.
• see also:
  • sddssnapshot()
  • sddscaramp()
• author: Hairong Shang, ANL/APS.