Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 6/20/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

3.1.35.24. get_object_info (::quartus::sta)

The following table displays information for the get_object_info Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta

Syntax get_object_info [-h | -help] [-long_help] [-name] [-type] <object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-name Return the object name
-type Return the object type
<object> Object
Description
Gets information about the specified object (referenced by object
ID). Object IDs can be obtained by Tcl commands such as get_clocks,
get_ports, get_cells, and others. The -type option returns "clk",
"reg", "port", "cell", "pin", "comb", "net", or "edge". The -name and
-type options are mutually exclusive.
Example Usage
project_open chiptrip
create_timing_netlist
set ports [get_ports]
foreach_in_collection port $ports {
    puts [get_object_info $port -name]
}
delete_timing_netlist
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Argument <string> is a collection ID that does not link to any collection. Specify a legal collection ID.
TCL_ERROR 1 ERROR: Argument <string> is an object ID that does not link to any object. Specify a valid object ID.
TCL_ERROR 1 ERROR: Argument <string> is an empty collection. Specify one that is a non-empty collection.
TCL_ERROR 1 ERROR: Argument <string> is not a valid object. Specify a valid object.
TCL_ERROR 1 ERROR: Argument <string> gives an empty collection. Specify one that gives a non-empty collection.
TCL_ERROR 1 ERROR: Argument <string> gives a collection with more than one object. Specify one that gives a collection with one object.
TCL_ERROR 1 ERROR: Argument <string> gives a collection that is not of <string> type. Specify one that gives a collection of required type.
TCL_ERROR 1 ERROR: Argument <string> gives an object that is not of <string> type. Specify one that gives an object of required type.
TCL_ERROR 1 ERROR: Argument <string> is a collection with more than one object. Specify a collection with one object.
TCL_ERROR 1 ERROR: Argument <string> is not a collection ID. Specify a legal collection ID.
TCL_ERROR 1 ERROR: Argument <string> is not an object ID. Specify a valid object ID.
TCL_ERROR 1 ERROR: Argument <string> is an object filter that matches more than one object. Specify a filter that matches only one object.
TCL_ERROR 1 ERROR: Argument <string> is an object filter that matches no objects. Specify one matches only one object.
TCL_ERROR 1 ERROR: Object with ID <string> is not an object of type <string>. Specify the ID of an object with the correct type.
TCL_ERROR 1 ERROR: Cannot find object of ID <string>. Specify an existing object ID.
TCL_ERROR 1 ERROR: Unsupported object type: <string>. Specify a supported object type.
TCL_ERROR 1 ERROR: Argument <string> is a collection that is not of <string> type. Specify a collection of required type.
TCL_ERROR 1 ERROR: Argument <string> is an object that is not of <string> type. Specify an object of required type.
TCL_ERROR 1 ERROR: Argument <string> is not <string> <string>. Specify an argument of the correct type.