Description | Example | Return Message | Group

StopWatchGet

Stop the StopWatch counter and return the time or return split times without stopping the counter

Syntax

StopWatchGet <ApplicationPath> {Stop | Split} [{TimeUnits}]

Related Commands

Description

The StopWatchGet command is used in conjunction with the StopWatch command, which allows you to start or reset the counter.

This command allows you (1) to stop the counter that was set using the StopWatch command or (2) to return time data at the current value for the counter when the command was executed.

If Stop is entered the counter stops and Connect returns time elapsed from the StopWatch Start command to the StopWatchGet Stop command.

If Split is entered the counter continues and Connect returns the elapsed time from the StopWatch Start command to the StopWatchGet Split command as well as the total elapsed time since the StopWatch Start command was sent.

If the {TimeUnits} parameter isn't included in the command, return data is in seconds. Currently the only valid value for {TimeUnits} is HMS.

To find out more about how the StopWatch and StopWatchGet commands can be used for, see the StopWatch and StopWatchGet in a real-world situation example in the StopWatch command documentation.

Example

To find out the value (in hours, minutes, seconds) of the counter at the time you send the command without resetting the counter:

StopWatchGet / Split HMS

ReturnMessage

Connect returns a message that contains the value of the counter in hours, minutes, seconds format as illustrated in the following sample:
ACK
STOPWATCHGET 28
00:00:10.0001, 00:00:20.0001

Group Membership

This command belongs to the following group(s):

Application Options

Version

4.0.5

STK Programming Interface 11.0.1