By default, only the objects in the current namespace are listed (see the change-namespace command). The namespace argument can be used to override the current namespace. (The component argument is a deprecated alias of namespace.)
When the namespace argument is used, objects in standard sub-namespaces are always included, e.g. list-objects namespace=DEV will always include objects hierarchies rooted at DEV.bank, DEV.port and DEV.impl.
Objects of class index-map are only listed if specifically asked for, using the class argument.
If the optional substr argument is specified, only objects with a name matching this sub-string will be printed. The current namespace part of the object name will not be included in the name matched against.
The default is to list objects in the current namespace as well as namespaces below, i.e. list the whole tree rooted at the given namespace. Use the -local flag to only list the current namespace.
The -show-port-objects flag will include port objects in the result; this includes "port", "bank", and "impl" objects.
With the -all flag, all objects are listed, regardless of namespace. This implies the -show-port-objects flag.
By default objects are sorted by name. The -sort-by-classname flag sorts them by class name instead.
Component objects are printed first and then all other objects. Use the -a flag to mix all objects in the same list.
The -tree flag prints a tree of all the objects descending from the current namespace. This implies -recursive. If -all is given the tree will start from the root. Objects not belonging to any hierarchy will be put in the root node. Arrays of leaf objects will be summarized unless -expand-all is given. With the -with-class-name flag class names are added to all non port objects. The max-depth argument can be used to only traverse the object tree up to the given depth.
The -class-desc flag will include a short description in the result.
The port argument selects objects that have all the interfaces specified as port/bank. Writing list-objects port=signal will return obj.port/bank.RESET if RESET is type interface signal, as well as the root object obj.
The list-objects command returns a list of objects when used in an expression. The get-object-list only returns such a list.