API reference - Class LayerMapping
Notation used in Ruby API documentation
Description: A layer mapping (source to target layout)
- Public constructors
- Public methods
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
A layer mapping is an association of layers in two layouts forming pairs of layers, i.e. one layer corresponds to another layer in the other layout. The LayerMapping object describes the mapping of layers of a source layout A to a target layout B.
A layer mapping can be set up manually or using the methods create or create_full.
lm = RBA::LayerMapping::new # explicit: lm.map(2, 1) # map layer index 2 of source to 1 of target lm.map(7, 3) # map layer index 7 of source to 3 of target ... # or employing the specification identity: lm.create(target_layout, source_layout) # plus creating layers which don't exist in the target layout yet: new_layers = lm.create_full(target_layout, source_layout)
A layer might not be mapped to another layer which basically means that there is no corresponding layer. Such layers will be ignored in operations using the layer mapping. Use create_full to ensure all layers of the source layout are mapped.
LayerMapping objects play a role mainly in the hierarchical copy or move operations of Layout. However, use is not restricted to these applications.
This class has been introduced in version 0.23.
Public constructors
| new LayerMapping ptr | new | Creates a new object of this class |
Public methods
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const LayerMapping other) | Assigns another object to self | |
| void | clear | Clears the mapping. | ||
| void | create | (const Layout layout_a, const Layout layout_b) | Initialize the layer mapping from two layouts | |
| unsigned int[] | create_full | (Layout layout_a, const Layout layout_b) | Initialize the layer mapping from two layouts | |
| [const] | new LayerMapping ptr | dup | Creates a copy of self | |
| [const] | bool | has_mapping? | (unsigned int layer_index_b) | Determine if a layer in layout_b has a mapping to a layout_a layer. |
| [const] | unsigned int | layer_mapping | (unsigned int layer_index_b) | Determine layer mapping of a layout_b layer to the corresponding layout_a layer. |
| void | map | (unsigned int layer_index_b, unsigned int layer_index_a) | Explicitly specify a mapping. | |
| [const] | map<unsigned int,unsigned int> | table | Returns the mapping table. |
Deprecated methods (protected, public, static, non-static and constructors)
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
Detailed description
_create | Signature: void _create Description: 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. | ||||||
_destroy | Signature: void _destroy Description: 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. | ||||||
_destroyed? | Signature: [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. | ||||||
_is_const_object? | Signature: [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. | ||||||
_manage | Signature: void _manage Description: 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. | ||||||
_unmanage | Signature: void _unmanage Description: 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. | ||||||
assign | Signature: void assign (const LayerMapping other) Description: Assigns another object to self | ||||||
clear | Signature: void clear Description: Clears the mapping. | ||||||
create | Signature: void create (const Layout layout_a,const Layout layout_b) Description: Initialize the layer mapping from two layouts
The layer mapping is created by looking up each layer of layout_b in layout_a. All layers with matching specifications (LayerInfo) are mapped. Layouts without a layer/datatype/name specification will not be mapped. create_full is a version of this method which creates new layers in layout_a if no corresponding layer is found. | ||||||
create_full | Signature: unsigned int[] create_full (Layout layout_a,const Layout layout_b) Description: Initialize the layer mapping from two layouts
The layer mapping is created by looking up each layer of layout_b in layout_a. All layers with matching specifications (LayerInfo) are mapped. Layouts without a layer/datatype/name specification will not be mapped. Layers with a valid specification which are not found in layout_a are created there. | ||||||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead | ||||||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead | ||||||
dup | Signature: [const] new LayerMapping ptr dup Description: Creates a copy of self | ||||||
has_mapping? | Signature: [const] bool has_mapping? (unsigned int layer_index_b) Description: Determine if a layer in layout_b has a mapping to a layout_a layer.
| ||||||
is_const_object? | Signature: [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 | ||||||
layer_mapping | Signature: [const] unsigned int layer_mapping (unsigned int layer_index_b) Description: Determine layer mapping of a layout_b layer to the corresponding layout_a layer.
| ||||||
map | Signature: void map (unsigned int layer_index_b,unsigned int layer_index_a) Description: Explicitly specify a mapping.
Beside using the mapping generator algorithms provided through create and create_full, it is possible to explicitly specify layer mappings using this method. | ||||||
new | Signature: [static] new LayerMapping ptr new Description: Creates a new object of this class Python specific notes: | ||||||
table | Signature: [const] map<unsigned int,unsigned int> table Description: Returns the mapping table. The mapping table is a dictionary where the keys are source layout layer indexes and the values are the target layout layer indexes. This method has been introduced in version 0.25. |