API reference - Class LayerMapNotation used in Ruby API documentation Description: An object representing an arbitrary mapping of physical layers to logical layers
"Physical" layers are stream layers or other separated layers in a CAD file. "Logical" layers are the layers present in a Layout object. Logical layers are represented by an integer index while physical layers are given by a layer and datatype number or name. A logical layer is created automatically in the layout on reading if it does not exist yet. The mapping describes an association of a set of physical layers to a set of logical ones, where multiple physical layers can be mapped to a single logical one, which effectively merges the layers. For each logical layer, a target layer can be specified. A target layer is the layer/datatype/name combination as which the logical layer appears in the layout. By using a target layer different from the source layer renaming a layer can be achieved while loading a layout. Another use case for that feature is to assign layer names to GDS layer/datatype combinations which are numerical only. LayerMap objects are used in two ways: as input for the reader (inside a LoadLayoutOptions class) and as output from the reader (i.e. Layout::read method). For layer map objects used as input, the layer indexes (logical layers) can be consecutive numbers. They do not need to correspond with real layer indexes from a layout object. When used as output, the layer map's logical layers correspond to the layer indexes inside the layout that the layer map was used upon. This is a sample how to use the LayerMap object. It maps all datatypes of layers 1, 2 and 3 to datatype 0 and assigns the names 'ONE', 'TWO' and 'THREE' to these layout layers: lm = RBA::LayerMap::new
lm.map("1/0-255 : ONE (1/0)", 0)
lm.map("2/0-255 : TWO (2/0)", 1)
lm.map("3/0-255 : THREE (3/0)", 2)
# read the layout using the layer map
lo = RBA::LoadLayoutOptions::new
lo.layer_map.assign(lm)
ly = RBA::Layout::new
ly.read("input.gds", lo)
The LayerMap class has been introduced in version 0.18. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed descriptionvoid _createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. void _destroyDescription: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. [const] bool _destroyed?Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. [const] bool _is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. void _manageDescription: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. void _unmanageDescription: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. void assign(const LayerMap other)Description: Assigns another object to self void clearDescription: Clears the map. void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] new LayerMap ptr dupDescription: Creates a copy of self [static] LayerMap from_string(string arg1)Description: Creates a layer map from the given string The format of the string is that used in layer mapping files: one mapping entry per line, comments are allowed using '#' or '//'. The format of each line is that used in the 'map(string, index)' method. This method has been introduced in version 0.23. [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead [const] bool is_mapped?(const LayerInfo layer)Description: Check, if a given physical layer is mapped.
[const] int logical(const LayerInfo layer)Description: Returns the logical layer (the layer index in the layout object) for a given physical layer.
void map(const LayerInfo phys_layer,unsigned int log_layer)Description: Maps a physical layer to a logical one.
In general, there may be more than one physical layer mapped to one logical layer. This method will add the given physical layer to the mapping for the logical layer. void map(const LayerInfo phys_layer,unsigned int log_layer,const LayerInfo target_layer)Description: Maps a physical layer to a logical one with a target layer.
In general, there may be more than one physical layer mapped to one logical layer. This method will add the given physical layer to the mapping for the logical layer. This method has been added in version 0.20. void map(const LayerInfo pl_start,const LayerInfo pl_stop,unsigned int log_layer)Description: Maps a physical layer interval to a logical one.
This method maps an interval of layers l1..l2 and datatypes d1..d2 to the mapping for the given logical layer. l1 and d1 are given by the pl_start argument, while l2 and d2 are given by the pl_stop argument. void map(const LayerInfo pl_start,const LayerInfo pl_stop,unsigned int log_layer,const LayerInfo arg4)Description: Maps a physical layer interval to a logical one with a target layer.
This method maps an interval of layers l1..l2 and datatypes d1..d2 to the mapping for the given logical layer. l1 and d1 are given by the pl_start argument, while l2 and d2 are given by the pl_stop argument. This method has been added in version 0.20. void map(string map_expr,unsigned int log_layer)Description: Maps a physical layer given by a string to a logical one.
The string expression is constructed using the syntax: "list[/list][;..]" for layer/datatype pairs. "list" is a sequence of numbers, separated by comma values or a range separated by a hyphen. Examples are: "1/2", "1-5/0", "1,2,5/0", "1/5;5/6". A target layer can be specified with the ":<target>" notation where the target is a valid layer specification string (i.e. "1/0"). Target mapping has been added in version 0.20. [const] LayerInfo mapping(unsigned int log_layer)Description: Returns the mapped physical (or target if one is specified) layer for a given logical layer.
In general, there may be more than one physical layer mapped to one logical layer. This method will return a single one of them. It will return the one with the lowest layer and datatype. [const] string mapping_str(unsigned int log_layer)Description: Returns the mapping string for a given logical layer.
The mapping string is compatible with the string that the "map" method accepts. [static] new LayerMap ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object [const] string to_stringDescription: Converts a layer mapping object to a string This method is the inverse of the from_string method. This method has been introduced in version 0.23. |