get_layers
get_layers
[ -with_shapes ]
[ -visible true | false | dont_care ]
[ -active true | false | dont_care ]
[ -material [ [metal] [cut] [poly] [other] [all] ] ]
[ -output_format layers | lpps | lpp_settings ]
[ -routing [ true | false ] ]
[ -colored [ true | false ] ]
[ -window_id i_windowID ] | [ -tech_lib s_techName ]
Description
Returns a list of layer names and objects in the given window or technology library that meet the criteria specified by the command arguments. If no arguments are given, the returned list includes all layers and, optionally, objects defined in the technology library for the active window. The visibility and active state for layers and objects are set in the Layer Object Display Panel of the GUI.
The GUI equivalent for this command is Window—Layer Object Panel.
Arguments
|
-active true | false | dont_care
|
|
|
Specifies which layers and objects to include in the return list.
|
|
|
dont_care
|
Includes all layers and objects.
|
|
|
false
|
Includes only layers and objects that are not active.
|
|
|
true
|
Includes only layers and objects that are active.
|
|
-colored
|
When specified, returns the layer names that support coloring. Default is true.
|
|
-material [ [metal][cut][poly][other][all] ]
|
|
|
Specifies the material types of the layers to list. The default is all materials.
|
|
-output_format layers | lpps | lpp_settings
|
|
|
Specifies the list output format.
|
|
|
layers
|
Returns a list of layer names that meet the criteria. Objects are not included. This is the default.
|
|
|
lpp_settings
|
Returns a list of layer purposes and objects that meet the criteria with their associated visibility, active state, and opacity.
|
|
|
lpps
|
Returns a list of layer purposes and objects that meet the criteria.
|
|
-routing [ true | false ]
|
|
|
Returns the routing layer names.
|
|
-tech_lib s_techName
|
Uses the given technology library. If this argument is given, the -output_format, -with_shapes, -visible, and -active arguments are ignored and the list of all layers and objects is output. The technology library must be defined in lib.defs.
|
|
-visible true | false | dont_care
|
|
|
Specifies which layers and objects to include in the return list.
|
|
|
dont_care
|
Includes all layers and objects.
|
|
|
false
|
Includes only layers and objects that are not visible.
|
|
|
true
|
Includes only layers and objects that are visible.
|
|
-window_id i_windowID
|
Uses the design in the given window. If this argument is not given, the active window is used.
|
|
-with_shapes
|
Restricts layers to those that contain shapes. If this argument is not given, all defined layers that meet the criteria are listed.
|
Value Returned
|
{s_layerlpp [ s_visibilityBool s_activeBool i_opacity ]}…
|
|
|
Is the list of layer/objects that meet the criteria represented as strings. If used, the -output_format argument determines the format of list items.
|
Examples
The following command requests all layers that contain shapes that are active and visible in the active window.
get_layers -active true -visible true -with_shapes
The following command requests all defined layer purpose pairs in the active window.
get_layers -output_format lpps
The following command requests all defined layer purposes and objects in the mytechLib technology library.
get_layers -tech_lib mytechLib -output_format lpps
Related Topics
View Commands
set_active
view_layer
Return to top
