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.

• example:

  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>] 
    [-time=<timeToRun>,<timeUnits>] [-interval=<timeInterval>,<timeUnits>] 
    [-runControlPV={string=<string>|parameter=<string>},pingTimeout=<value>,
    pingInterval=<value>] 
    [-runControlDescription={string=<string>|parameter=<string>}] 
    [-pendIOtime=<value>] [-verbose] [-testValues=<file>[,limit=<number>]]
  

• 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 double columns: MaximumValue and MinimumValue, which are also required. seconds between two settings of the correctors.

• switches:
  • -pvOutput -- optional. the output pv name for storing the testing results of PVs in the input. If it is not given,the results are printed out.
  • -time --required. Total time for testing process variable. Valid time units are seconds,minutes,hours, or days.
  • -interval --optional. Desired time interval for testing, the units are same as time.
  • -runControlPV -- specifies the runControl PV record. string|parameter is required, pingInterval and pingTimeout are optional.
  • -runControlDescription --specifies a string parameter whose value is a runControl PV description record.
  • -verbose - print out messages.
  • -pendIOtime - sets the maximum time to wait for return of each value.
  • -testValues<file>,[limit=<number>] - file is sdds format file containing minimum and maximum values of PV's specifying a range outside of which the feedback is temporarily suspended. Column names are ControlName, MinimumValue, MaximumValue. Optional column names are SleepTime, ResetTime. limits is the maixum number of failure times. The program will be terminated when the continuous failure times reaches the limit.
• see also:
  • sddscontrollaw
• author: H. Shang, ANL