Name

abc::read — read a circuit description into ABC

Synopsis

abc::read [result] [parameters] [timeout]

DESCRIPTION

Sends the command read parameters to ABC and waits for a prompt. Parses the output to detect errors reported by ABC.

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.

string parameters (in)

Optional argument. Parameters for the ABC read command. Defaults to an empty string. This argument, although syntactically optional, is necessary, because it has to define the name of the file to read.

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_OPEN
Diagnostic: The file specified in parameters could not be opened.
Error Code: ABC_E_SUFFIX
Diagnostic: The kind of circuit description could not be determined from the file name specified in parameters
Error Code: ABC_E_READ
Diagnostic: ABC could not input the circuit description in the specified file.

SEE ALSO

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