DDDriverTimerCommands

Last Updated:10/20/2016 04:35:53

Driver Commands for Timer functions

Driver Command record format:
Field #1
The "C" = DRIVER COMMAND record type specifier.
Field #2
The Driver Command keyword.

Example:

c , SetApplicationMap , "AppMap.map"

[How To Read This Reference]
ResetTimer
RJ TID SDC
Reset a "stopped" timer for reuse.
StartTimer
RJ TID SDC
Will start a unique timer.
StopTimer
RJ TID SDC
Will end a unique timer and perform a verify test if a value was supplied at start time.
StoreTimerInfo
RJ TID SDC
Well store the timer information in the given variable. Information stored: .elapsed - Amount of seconds that has passed. .startTime - Time that the timer was started. .endTime - Time that the timer was stopped. .failures - Number of failures that happened on the timer (based on verify commands).
StoreTimerInfoFile
RJ TID SDC
Well store the timer information in the given file, in csv format. Will use absolute path if given otherwise uses SAFS Project Directory. Information Stored:Name,Start,Stop,Duration,Timeout,Pass? Name - Name of timer Start - Time of start Stop - Time of stop Duration - total elapsed time. Timeout - Pass? - if the timer passed any verfiy commands. Variable TimerStorageVariables can list additional variables to be stored in the file (comma delimited).
VerifyElapsedTimeInRange
RJ TID SDC
Well verify that a timer was in the range of the given values.
VerifyElapsedTimeIsLess
RJ TID SDC
Well verify that a timer was less then the given value.
VerifyElapsedTimeIsMore
RJ TID SDC
Well verify that a timer was greater then the given value.
VerifyTimer
RJ TID SDC
Well verify that a timer was less then the given value.

DDDriverTimerCommands::ResetTimer
RJ TID SDC

Reset a "stopped" timer for reuse.

Returns internal status values to a reset state. This allows the timer to be used again with a new start time when StartTimer is called with the same name as this timer. It should be considered an error to attempt to reset a timer that is active (not stopped).

Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


Examples:
[How To Read This Reference]

DDDriverTimerCommands::StartTimer
RJ TID SDC

Will start a unique timer.


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. [ verifyValue = ]
    verifyValue will be used to verify the timer was less then then given value. If the parameter isn't given then no check will occur.


Examples:
  • C, StartTimer, exampleTimer
    Timer exampleTimer has been started.


  • C, StartTimer, exampleTimer, 30
    Timer exampleTimer has been started and once StopTimer command has been issued a verification of the timer will be excuted with the value 30.


[How To Read This Reference]

DDDriverTimerCommands::StopTimer
RJ TID SDC

Will end a unique timer and perform a verify test if a value was supplied at start time.


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


Examples:
  • C, StopTimer, exampleTimer
    Timer exampleTimer has been started.


[How To Read This Reference]

DDDriverTimerCommands::StoreTimerInfo
RJ TID SDC

Well store the timer information in the given variable.
Information stored:
.elapsed - Amount of seconds that has passed.
.startTime - Time that the timer was started.
.endTime - Time that the timer was stopped.
.failures - Number of failures that happened on the timer (based on verify commands).


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. variable
    variable to store time information in.


Examples:
  • C, StoreTimerInfo, exampleTimer, TimerVar
    Will store exampleTimer information in TimerVar.


[How To Read This Reference]

DDDriverTimerCommands::StoreTimerInfoFile
RJ TID SDC

Well store the timer information in the given file, in csv format. Will use absolute path if given otherwise uses SAFS Project Directory.
Information Stored:Name,Start,Stop,Duration,Timeout,Pass?
Name - Name of timer
Start - Time of start
Stop - Time of stop
Duration - total elapsed time.
Timeout -
Pass? - if the timer passed any verfiy commands.
Variable TimerStorageVariables can list additional variables to be stored in the file (comma delimited).


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. fileLoc
    fileLoc is the location of the file to write (including filename). If an absolute path is given then it is used other wise the default path is SAFS Project Directory. If the file exists it is just appended to.


Examples:
  • C, StoreTimerInfoFile, exampleTimer, "c:\temp\temp.csv"
    Will store exampleTimer information in the file located at c:\temp\temp.csv.


[How To Read This Reference]

DDDriverTimerCommands::VerifyElapsedTimeInRange
RJ TID SDC

Well verify that a timer was in the range of the given values.


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. verifyValue1
    verifyValue1 will be used as the lower bounds of the check.


  3. verifyValue2
    verifyValue2 will be used as the higher bounds of the check.


Examples:
  • C, VerifyElapsedTimeInRange, exampleTimer, 10, 30
    Verifies that the exampleTimer was between 10 and 30.


[How To Read This Reference]

DDDriverTimerCommands::VerifyElapsedTimeIsLess
RJ TID SDC

Well verify that a timer was less then the given value.


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. verifyValue
    verifyValue will be used to as the check value.


Examples:
  • C, VerifyElapsedTimeIsLess, exampleTimer, 10
    Verifies that the exampleTimer was less then 10 seconds.


[How To Read This Reference]

DDDriverTimerCommands::VerifyElapsedTimeIsMore
RJ TID SDC

Well verify that a timer was greater then the given value.


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. verifyValue
    verifyValue will be used to as the check value.


Examples:
  • C, VerifyElapsedTimeIsMore, exampleTimer, 10
    Verifies that the exampleTimer was greater then 10 seconds.


[How To Read This Reference]

DDDriverTimerCommands::VerifyTimer
RJ TID SDC

Well verify that a timer was less then the given value.


Fields: [ ]=Optional with Default Value
  1. timerName
    timerName (should be unique)


  2. [ verifyValue = ]
    verifyValue will be used to as the check value. If nothing is given then the value given during StartTimer will be use, if nothing was given then the value -1 is used.


Examples:
  • C, VerifyTimer, exampleTimer 10
    Verifies that the exampleTimer was less then 10 seconds.


  • C, VerifyTimer, exampleTimer
    Verifies that the exampleTimer was less then the number given during StartTimer or -1.


[How To Read This Reference]