org.safs.model.commands

Class DDDriverTimerCommands

java.lang.Object

org.safs.model.commands.DDDriverTimerCommands

public class DDDriverTimerCommands
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESETTIMER_KEYWORD "ResetTimer"
static java.lang.String	StartTimer_KEYWORD "StartTimer"
static java.lang.String	StopTimer_KEYWORD "StopTimer"
static java.lang.String	StoreTimerInfo_KEYWORD "StoreTimerInfo"
static java.lang.String	StoreTimerInfoFile_KEYWORD "StoreTimerInfoFile"
static java.lang.String	VerifyElapsedTimeInRange_KEYWORD "VerifyElapsedTimeInRange"
static java.lang.String	VerifyElapsedTimeIsLess_KEYWORD "VerifyElapsedTimeIsLess"
static java.lang.String	VerifyElapsedTimeIsMore_KEYWORD "VerifyElapsedTimeIsMore"
static java.lang.String	VerifyTimer_KEYWORD "VerifyTimer"

Method Summary

Modifier and Type	Method and Description
static DDDriverTimerCommands	getInstance() public Singleton to access class static methods via instance
static DriverCommand	resetTimer(java.lang.String timerName) Reset a "stopped" timer for reuse.
static DriverCommand	startTimer(java.lang.String[] parameters) Will start a unique timer.
static DriverCommand	startTimer(java.lang.String timerName, java.lang.String verifyValue) Will start a unique timer.
static DriverCommand	stopTimer(java.lang.String timerName) Will end a unique timer and perform a verify test if a value was supplied at start time.
static DriverCommand	storeTimerInfo(java.lang.String[] parameters) Well store the timer information in the given variable.
static DriverCommand	storeTimerInfo(java.lang.String timerName, java.lang.String variable) Well store the timer information in the given variable.
static DriverCommand	storeTimerInfoFile(java.lang.String[] parameters) Well store the timer information in the given file, in csv format.
static DriverCommand	storeTimerInfoFile(java.lang.String timerName, java.lang.String fileLoc) Well store the timer information in the given file, in csv format.
static DriverCommand	verifyElapsedTimeInRange(java.lang.String[] parameters) Well verify that a timer was in the range of the given values.
static DriverCommand	verifyElapsedTimeInRange(java.lang.String timerName, java.lang.String verifyValue1, java.lang.String verifyValue2) Well verify that a timer was in the range of the given values.
static DriverCommand	verifyElapsedTimeIsLess(java.lang.String[] parameters) Well verify that a timer was less then the given value.
static DriverCommand	verifyElapsedTimeIsLess(java.lang.String timerName, java.lang.String verifyValue) Well verify that a timer was less then the given value.
static DriverCommand	verifyElapsedTimeIsMore(java.lang.String[] parameters) Well verify that a timer was greater then the given value.
static DriverCommand	verifyElapsedTimeIsMore(java.lang.String timerName, java.lang.String verifyValue) Well verify that a timer was greater then the given value.
static DriverCommand	verifyTimer(java.lang.String[] parameters) Well verify that a timer was less then the given value.
static DriverCommand	verifyTimer(java.lang.String timerName, java.lang.String verifyValue) Well verify that a timer was less then the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESETTIMER_KEYWORD

public static final java.lang.String RESETTIMER_KEYWORD

"ResetTimer"

See Also:

Constant Field Values

StartTimer_KEYWORD

public static final java.lang.String StartTimer_KEYWORD

"StartTimer"

See Also:

Constant Field Values

StopTimer_KEYWORD

public static final java.lang.String StopTimer_KEYWORD

"StopTimer"

See Also:

Constant Field Values

StoreTimerInfo_KEYWORD

public static final java.lang.String StoreTimerInfo_KEYWORD

"StoreTimerInfo"

See Also:

Constant Field Values

StoreTimerInfoFile_KEYWORD

public static final java.lang.String StoreTimerInfoFile_KEYWORD

"StoreTimerInfoFile"

See Also:

Constant Field Values

VerifyElapsedTimeInRange_KEYWORD

public static final java.lang.String VerifyElapsedTimeInRange_KEYWORD

"VerifyElapsedTimeInRange"

See Also:

Constant Field Values

VerifyElapsedTimeIsLess_KEYWORD

public static final java.lang.String VerifyElapsedTimeIsLess_KEYWORD

"VerifyElapsedTimeIsLess"

See Also:

Constant Field Values

VerifyElapsedTimeIsMore_KEYWORD

public static final java.lang.String VerifyElapsedTimeIsMore_KEYWORD

"VerifyElapsedTimeIsMore"

See Also:

Constant Field Values

VerifyTimer_KEYWORD

public static final java.lang.String VerifyTimer_KEYWORD

"VerifyTimer"

See Also:

Constant Field Values

Method Detail

getInstance

public static DDDriverTimerCommands getInstance()

public Singleton to access class static methods via instance

resetTimer

public static DriverCommand resetTimer(java.lang.String timerName)

                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).
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

startTimer

public static DriverCommand startTimer(java.lang.String timerName,
                                       java.lang.String verifyValue)

                Will start a unique timer.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:YES 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.

startTimer

public static DriverCommand startTimer(java.lang.String[] parameters)

                Will start a unique timer.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:YES 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.

stopTimer

public static DriverCommand stopTimer(java.lang.String timerName)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

storeTimerInfo

public static DriverCommand storeTimerInfo(java.lang.String timerName,
                                           java.lang.String variable)

                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).
                  
                
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

variable - Optional:No variable to store time information in.

storeTimerInfo

public static DriverCommand storeTimerInfo(java.lang.String[] parameters)

                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).
                  
                
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
variable -- Optional:No variable to store time information in.

storeTimerInfoFile

public static DriverCommand storeTimerInfoFile(java.lang.String timerName,
                                               java.lang.String fileLoc)

                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).
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

fileLoc - Optional:No 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.

storeTimerInfoFile

public static DriverCommand storeTimerInfoFile(java.lang.String[] parameters)

                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).
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
fileLoc -- Optional:No 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.

verifyElapsedTimeInRange

public static DriverCommand verifyElapsedTimeInRange(java.lang.String timerName,
                                                     java.lang.String verifyValue1,
                                                     java.lang.String verifyValue2)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue1 - Optional:No verifyValue1 will be used as the lower bounds of the check.

verifyValue2 - Optional:No verifyValue2 will be used as the higher bounds of the check.

verifyElapsedTimeInRange

public static DriverCommand verifyElapsedTimeInRange(java.lang.String[] parameters)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
verifyValue1 -- Optional:No verifyValue1 will be used as the lower bounds of the check.
verifyValue2 -- Optional:No verifyValue2 will be used as the higher bounds of the check.

verifyElapsedTimeIsLess

public static DriverCommand verifyElapsedTimeIsLess(java.lang.String timerName,
                                                    java.lang.String verifyValue)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:No verifyValue will be used to as the check value.

verifyElapsedTimeIsLess

public static DriverCommand verifyElapsedTimeIsLess(java.lang.String[] parameters)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:No verifyValue will be used to as the check value.

verifyElapsedTimeIsMore

public static DriverCommand verifyElapsedTimeIsMore(java.lang.String timerName,
                                                    java.lang.String verifyValue)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:No verifyValue will be used to as the check value.

verifyElapsedTimeIsMore

public static DriverCommand verifyElapsedTimeIsMore(java.lang.String[] parameters)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:No verifyValue will be used to as the check value.

verifyTimer

public static DriverCommand verifyTimer(java.lang.String timerName,
                                        java.lang.String verifyValue)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:YES 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.

verifyTimer

public static DriverCommand verifyTimer(java.lang.String[] parameters)

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

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:YES 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.