2 gettimertime(), 3 killtimer(), Imer – Teledyne LeCroy SAS_SATA Protocol Suite Verification Script Engine Reference Manual User Manual

Page 53

Advertising
background image


53

11.2 GetTimerTime()

Calculates and returns the timing interval (VSE Time object) between the Time-at SetTimer()
and Current Time. For example, if
T1 is the time when SetTimer(<timer_id>) is being called for an event; and
T2 is the current time when GetTimerTime(<timer_id>) is called.
Then
T = T2 – T1 is the timing interval returned by the GetTimerTime(<timer_id>) function, where T
is of type VSE Time object, which can be converted into a string using the TimeToText()
function (refer to

Chapter 13

for detailed explanation).



Format :

GetTimerTime ( timer_id = 0)



Parameters

timer_id

Unique timer identifier


Return value

Returns VSE time object from timer with id = timer_id.

Example

GetTimerTime (); # Retrieve timing interval for timer with id = 0;
GetTimerTime (23); # Retrieve timing interval for timer with id = 23;


Remark

This function, when called, does not reset the timer.

11.3 KillTimer()

Kills/stops a specific running Timer (with Timer-ID = <timer_id> used by SetTimer()) and frees
its corresponding resources.


Format :

KillTimer( timer_id = 0)



Parameter

timer_id

Unique timer identifier


Example

KillTimer(); # Stop timing for timer with id = 0;

KillTimer(23); # Stop timing for timer with id = 23;



Advertising