2.27 sddspvtest

• description: sddspvtest tests the process variable given by the inputfile are out-of-range or not and sets the number of out-of-range process variables to a control PV.
• examples:
  sddspvtest linac.sdds -time=20 -runControlPV={string=shang:ControlLawRC,pingTimeout=4}  
    -runControlDescription=string=hi

  where the contents of the file linac.sdds are

  SDDS1  
  &description text="Namecapture BURT Request File", contents="BURT Request", &end  
  &column name=ControlName, type=string,  &end  
  &column name=MaximumValue, type=double,  &end  
  &column name=MinimumValue, type=double,  &end  
  &data mode=ascii, &end  
  ! page number 1  
  linac  
                    10  
  soliday:PM1:X:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM1:Y:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM2:X:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM2:Y:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM3:X:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM3:Y:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM4:X:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM4:Y:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM5:X:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  soliday:PM5:Y:positionM  1.000000000000000e+00 -1.000000000000000e+00  
  .......  
  

• synopsis:
  usage: sddspvtest <inputFile> [-pvOutput=<pvName>[  
    ,passValue=<integer>,failValue=<integer>]]  
    [-time=<timeToRun>,<timeUnits>] [-interval=<timeInterval>,<timeUnits>]  
    [-monitor]  
    [-exitCondition={allPass|anyFail|converged=<cycles>|changed}]  
    [-runControlPV={string=<string>|parameter=<string>},pingTimeout=<value>,  
    pingInterval=<value>]  
    [-runControlDescription={string=<string>|parameter=<string>}]  
    [-pendIOtime=<value>] [-verbose]

• files:
  • input file:

    The variable input file is an SDDS file with one string column: ControlName, which is required and gives the list of control correctors (process variables or knobs). It also contains two double columns: MaximumValue and MinimumValue, which are also required. Optional columns are Monitor and ChangeLimit. Monitor values of Y or y cause monitoring to be used, while ChangeLimit values are used with the -exitCondition option.

• switches:
  • -pvOutput — optional. The output PV name for storing the testing results of PVs in the input. Qualifiers passValue and failValue set the values written for pass or fail. If it is not given, the number of failed tests is printed.
  • -time — required. Total time for testing process variables. Valid time units are seconds, minutes, hours, or days.
  • -interval — optional. Desired time interval for testing; units are the same as for -time.
  • -monitor — monitor all PVs regardless of the Monitor column.
  • -exitCondition — program exit criterion: allPass, anyFail, converged=<cycles>, or changed.
  • -runControlPV — specifies the runControl PV record. string or parameter is required; pingInterval and pingTimeout are optional.
  • -runControlDescription — specifies a string or parameter value used for a runControl PV description record.
  • -verbose — print out messages.
  • -pendIOtime — sets the maximum time to wait for return of each value.
• see also:
  • sddscontrollaw()
• author: Hairong Shang, ANL/APS.