abc::time
Prev   Next

Name

abc::time — measure time elapsed by ABC

Synopsis

abc::print_unate [result] [parameters] [timeout]

DESCRIPTION

Sends the command time parameters to ABC and waits for a prompt. Parses the output and converts values reported by ABC to items in the result array.

ARGUMENTS

array result (out)

Optional argument. If omitted, no information is returned. The following items are present:

string errorCode (out)

Error code. See RETURN CODES below. Also put to the errorCode global variable.

string rawOutput (out)

The unprocessed output of ABC, including the final prompt.

int promptNumber (out)

The number included in the final prompt. The ABC prompt has the "abc123> " form. The number indicates successive version of the network stored in ABC.

int cmdTime (out)

Time in milliseconds elapsed by the command.

float elapse (out)

Time elapsed by the time command itself as reported by the ABC process.

float total(out)

Time elapsed by ABC as reported by the ABC process.

string parameters (in)

Optional argument. Parameters for the respective ABC commands. Defaults to an empty string.

int timeout (in)

Optional argument. If given, sets the timeout of Expect for this command. Othervise, the value of the timeout global variable applies.

RETURN CODES

The procedure returns an empty string. See abctcl(n) , abc::messages(n) for error reporting and error symbols. The following error symbols can occur:

Error Code: ABC_E_BUSY
Diagnostic: Prompt from the previous command has not been detected yet.
Error Code: ABC_E_EOF
Diagnostic: A premature end-of-file detected. Perhaps the ABC process crashed.
Error Code: ABC_E_TOUT
Diagnostic: Timeout expired before the prompt was detected.
Error Code: ABC_E_PARAMS
Diagnostic: ABC could not interpret parameters.
Error Code: ABC_E_PARSE
Diagnostic: abc::print_unate could not parse the output of ABC. A new version with different labels might be in use.

SEE ALSO

abctcl(n) , abc::messages(n)

Prev   Next
abc::command Home abc::read