KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class LayoutDiff

API reference - Class LayoutDiff

Module: db

Description: The layout compare tool

Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description

The layout compare tool is a facility to quickly compare layouts and derive events that give details about the differences. The events are basically emitted following a certain order:

General configuration events (database units, layers ...)
on_begin_cell
on_begin_inst_differences (if the instances differ)
details about instance differences (if Verbose flag is given)
on_end_inst_differences (if the instances differ)
on_begin_layer
on_begin_polygon_differences (if the polygons differ)
details about polygon differences (if Verbose flag is given)
on_end_polygon_differences (if the polygons differ)
other shape difference events (paths, boxes, ...)
on_end_layer
repeated layer event groups
on_end_cell
repeated cell event groups

To use the diff facility, create a LayoutDiff object and call the compare_layout or compare_cell method:

lya = ... # layout A
lyb = ... # layout B

diff = RBA::LayoutDiff::new
diff.on_polygon_in_a_only do |poly|
  puts "Polygon in A: #{diff.cell_a.name}@#{diff.layer_info_a.to_s}: #{poly.to_s}"
end
diff.on_polygon_in_b_only do |poly|
  puts "Polygon in A: #{diff.cell_b.name}@#{diff.layer_info_b.to_s}: #{poly.to_s}"
end
diff.compare(lya, lyb, RBA::LayoutDiff::Verbose + RBA::LayoutDiff::NoLayerNames)

Public constructors

new LayoutDiff 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 LayoutDiff other)	Assigns another object to self
[const]	const Cell ptr	cell_a		Gets the current cell for the first layout
[const]	const Cell ptr	cell_b		Gets the current cell for the second layout
	bool	compare	(const Layout ptr a, const Layout ptr b, unsigned int flags = 0, int tolerance = 0)	Compares two layouts
	bool	compare	(const Cell ptr a, const Cell ptr b, unsigned int flags = 0, int tolerance = 0)	Compares two cells
[const]	new LayoutDiff ptr	dup		Creates a copy of self
[const]	int	layer_index_a		Gets the current layer for the first layout
[const]	int	layer_index_b		Gets the current layer for the second layout
[const]	LayerInfo	layer_info_a		Gets the current layer properties for the first layout
[const]	LayerInfo	layer_info_b		Gets the current layer properties for the second layout
[const]	const Layout ptr	layout_a		Gets the first layout the difference detector runs on
[const]	const Layout ptr	layout_b		Gets the second layout the difference detector runs on
[signal]	void	on_bbox_differs	(const Box ba, const Box bb)	This signal indicates a difference in the bounding boxes of two cells
[signal]	void	on_begin_box_differences		This signal indicates differences in the boxes on the current layer
[signal]	void	on_begin_cell	(const Cell ptr ca, const Cell ptr cb)	This signal indicates the sequence of events for a cell pair
[signal]	void	on_begin_edge_differences		This signal indicates differences in the edges on the current layer
[signal]	void	on_begin_edge_pair_differences		This signal indicates differences in the edge pairs on the current layer
[signal]	void	on_begin_inst_differences		This signal indicates differences in the cell instances
[signal]	void	on_begin_layer	(const LayerInfo layer, int layer_index_a, int layer_index_b)	This signal indicates differences on the given layer
[signal]	void	on_begin_path_differences		This signal indicates differences in the paths on the current layer
[signal]	void	on_begin_polygon_differences		This signal indicates differences in the polygons on the current layer
[signal]	void	on_begin_text_differences		This signal indicates differences in the texts on the current layer
[signal]	void	on_box_in_a_only	(const Box anotb, unsigned long prop_id)	This signal indicates a box that is present in the first layout only
[signal]	void	on_box_in_b_only	(const Box bnota, unsigned long prop_id)	This signal indicates a box that is present in the second layout only
[signal]	void	on_cell_in_a_only	(const Cell ptr c)	This signal indicates that the given cell is only present in the first layout
[signal]	void	on_cell_in_b_only	(const Cell ptr c)	This signal indicates that the given cell is only present in the second layout
[signal]	void	on_cell_meta_info_differs	(string name, variant a, variant b)	This signal indicates that meta info between the current cells differs
[signal]	void	on_cell_name_differs	(const Cell ptr ca, const Cell ptr cb)	This signal indicates a difference in the cell names
[signal]	void	on_dbu_differs	(double dbu_a, double dbu_b)	This signal indicates a difference in the database units of the layouts
[signal]	void	on_edge_in_a_only	(const Edge anotb, unsigned long prop_id)	This signal indicates an edge that is present in the first layout only
[signal]	void	on_edge_in_b_only	(const Edge bnota, unsigned long prop_id)	This signal indicates an edge that is present in the second layout only
[signal]	void	on_edge_pair_in_a_only	(const EdgePair anotb, unsigned long prop_id)	This signal indicates an edge pair that is present in the first layout only
[signal]	void	on_edge_pair_in_b_only	(const EdgePair bnota, unsigned long prop_id)	This signal indicates an edge pair that is present in the second layout only
[signal]	void	on_end_box_differences		This signal indicates the end of sequence of box differences
[signal]	void	on_end_cell		This signal indicates the end of a sequence of signals for a specific cell
[signal]	void	on_end_edge_differences		This signal indicates the end of sequence of edge differences
[signal]	void	on_end_edge_pair_differences		This signal indicates the end of sequence of edge pair differences
[signal]	void	on_end_inst_differences		This signal finishes a sequence of detailed instance difference events
[signal]	void	on_end_layer		This signal indicates the end of a sequence of signals for a specific layer
[signal]	void	on_end_path_differences		This signal indicates the end of sequence of path differences
[signal]	void	on_end_polygon_differences		This signal indicates the end of sequence of polygon differences
[signal]	void	on_end_text_differences		This signal indicates the end of sequence of text differences
[signal]	void	on_instance_in_a_only	(const CellInstArray anotb, unsigned long prop_id)	This signal indicates an instance that is present only in the first layout
[signal]	void	on_instance_in_b_only	(const CellInstArray bnota, unsigned long prop_id)	This signal indicates an instance that is present only in the second layout
[signal]	void	on_layer_in_a_only	(const LayerInfo a)	This signal indicates a layer that is present only in the first layout
[signal]	void	on_layer_in_b_only	(const LayerInfo b)	This signal indicates a layer that is present only in the second layout
[signal]	void	on_layer_name_differs	(const LayerInfo a, const LayerInfo b)	This signal indicates a difference in the layer names
[signal]	void	on_layout_meta_info_differs	(string name, variant a, variant b)	This signal indicates that global meta info differs
[signal]	void	on_path_in_a_only	(const Path anotb, unsigned long prop_id)	This signal indicates a path that is present in the first layout only
[signal]	void	on_path_in_b_only	(const Path bnota, unsigned long prop_id)	This signal indicates a path that is present in the second layout only
[signal]	void	on_per_layer_bbox_differs	(const Box ba, const Box bb)	This signal indicates differences in the per-layer bounding boxes of the current cell
[signal]	void	on_polygon_in_a_only	(const Polygon anotb, unsigned long prop_id)	This signal indicates a polygon that is present in the first layout only
[signal]	void	on_polygon_in_b_only	(const Polygon bnota, unsigned long prop_id)	This signal indicates a polygon that is present in the second layout only
[signal]	void	on_text_in_a_only	(const Text anotb, unsigned long prop_id)	This signal indicates a text that is present in the first layout only
[signal]	void	on_text_in_b_only	(const Text bnota, unsigned long prop_id)	This signal indicates a text that is present in the second layout only

Public static methods and constants

[static,const]	unsigned int	BoxesAsPolygons	Compare boxes to polygons
[static,const]	unsigned int	DontSummarizeMissingLayers	Don't summarize missing layers
[static,const]	unsigned int	FlattenArrayInsts	Compare array instances instance by instance
[static,const]	unsigned int	IgnoreDuplicates	Ignore duplicate instances or shapes
[static,const]	unsigned int	NoLayerNames	Do not compare layer names
[static,const]	unsigned int	NoProperties	Ignore properties
[static,const]	unsigned int	NoTextDetails	Ignore text details (font, size, presentation)
[static,const]	unsigned int	NoTextOrientation	Ignore text orientation
[static,const]	unsigned int	PathsAsPolygons	Compare paths to polygons
[static,const]	unsigned int	Silent	Silent compare - just report whether the layouts are identical
[static,const]	unsigned int	SmartCellMapping	Derive smart cell mapping instead of name mapping (available only if top cells are specified)
[static,const]	unsigned int	Verbose	Enables verbose mode (gives details about the differences)
[static,const]	unsigned int	WithMetaInfo	Ignore meta info

Deprecated methods (protected, public, static, non-static and constructors)

	void	create	Use of this method is deprecated. Use _create instead
	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

BoxesAsPolygons

Signature: [static,const] unsigned int BoxesAsPolygons

Description: Compare boxes to polygons

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'BoxesAsPolygons'. This is the getter.

DontSummarizeMissingLayers

Signature: [static,const] unsigned int DontSummarizeMissingLayers

Description: Don't summarize missing layers

If this mode is present, missing layers are treated as empty ones and every shape on the other layer will be reported as difference.

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'DontSummarizeMissingLayers'. This is the getter.

FlattenArrayInsts

Signature: [static,const] unsigned int FlattenArrayInsts

Description: Compare array instances instance by instance

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'FlattenArrayInsts'. This is the getter.

IgnoreDuplicates

Signature: [static,const] unsigned int IgnoreDuplicates

Description: Ignore duplicate instances or shapes

With this option present, duplicate instances or shapes are ignored and duplication does not count as a difference.

This option has been introduced in version 0.28.9.

Python specific notes:
The object exposes a readable attribute 'IgnoreDuplicates'. This is the getter.

NoLayerNames

Signature: [static,const] unsigned int NoLayerNames

Description: Do not compare layer names

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'NoLayerNames'. This is the getter.

NoProperties

Signature: [static,const] unsigned int NoProperties

Description: Ignore properties

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'NoProperties'. This is the getter.

NoTextDetails

Signature: [static,const] unsigned int NoTextDetails

Description: Ignore text details (font, size, presentation)

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'NoTextDetails'. This is the getter.

NoTextOrientation

Signature: [static,const] unsigned int NoTextOrientation

Description: Ignore text orientation

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'NoTextOrientation'. This is the getter.

PathsAsPolygons

Signature: [static,const] unsigned int PathsAsPolygons

Description: Compare paths to polygons

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'PathsAsPolygons'. This is the getter.

Silent

Signature: [static,const] unsigned int Silent

Description: Silent compare - just report whether the layouts are identical

Silent mode will not issue any signals, but instead the return value of the LayoutDiff#compare method will indicate whether the layouts are identical. In silent mode, the compare method will return immediately once a difference has been encountered so that mode may be much faster than the full compare.

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'Silent'. This is the getter.

SmartCellMapping

Signature: [static,const] unsigned int SmartCellMapping

Description: Derive smart cell mapping instead of name mapping (available only if top cells are specified)

Smart cell mapping is only effective currently when cells are compared (with LayoutDiff#compare with cells instead of layout objects).

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'SmartCellMapping'. This is the getter.

Verbose

Signature: [static,const] unsigned int Verbose

Description: Enables verbose mode (gives details about the differences)

See the event descriptions for details about the differences in verbose and non-verbose mode.

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set.

Python specific notes:
The object exposes a readable attribute 'Verbose'. This is the getter.

WithMetaInfo

Signature: [static,const] unsigned int WithMetaInfo

Description: Ignore meta info

This constant can be used for the flags parameter of compare_layouts and compare_cells. It can be combined with other constants to form a flag set. If present, this option tells the compare algorithm to include persisted meta info in the compare.

This flag has been introduced in version 0.28.16.

Python specific notes:
The object exposes a readable attribute 'WithMetaInfo'. This is the getter.

_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 LayoutDiff other)

Description: Assigns another object to self

cell_a

Signature: [const] const Cell ptr cell_a

Description: Gets the current cell for the first layout

This attribute is the current cell and is set after on_begin_cell and reset after on_end_cell.

cell_b

Signature: [const] const Cell ptr cell_b

Description: Gets the current cell for the second layout

This attribute is the current cell and is set after on_begin_cell and reset after on_end_cell.

compare

(1) Signature: bool compare (const Layout ptr a, const Layout ptr b, unsigned int flags = 0, int tolerance = 0)

Description: Compares two layouts

The first input layout

The second input layout

flags:

Flags to use for the comparison

tolerance:

A coordinate tolerance to apply (0: exact match, 1: one DBU tolerance is allowed ...)

Returns:

True, if the layouts are identical

Compares layer definitions, cells, instances and shapes and properties. Cells are identified by name. Only layers with valid layer and datatype are compared. Several flags can be specified as a bitwise or combination of the constants.

(2) Signature: bool compare (const Cell ptr a, const Cell ptr b, unsigned int flags = 0, int tolerance = 0)

Description: Compares two cells

The first top cell

The second top cell

flags:

Flags to use for the comparison

tolerance:

A coordinate tolerance to apply (0: exact match, 1: one DBU tolerance is allowed ...)

Returns:

True, if the cells are identical

Compares layer definitions, cells, instances and shapes and properties of two layout hierarchies starting from the given cells. Cells are identified by name. Only layers with valid layer and datatype are compared. Several flags can be specified as a bitwise or combination of the constants.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

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.

dup

Signature: [const] new LayoutDiff ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

layer_index_a

Signature: [const] int layer_index_a

Description: Gets the current layer for the first layout

This attribute is the current cell and is set after on_begin_layer and reset after on_end_layer.

layer_index_b

Signature: [const] int layer_index_b

Description: Gets the current layer for the second layout

This attribute is the current cell and is set after on_begin_layer and reset after on_end_layer.

layer_info_a

Signature: [const] LayerInfo layer_info_a

Description: Gets the current layer properties for the first layout

This attribute is the current cell and is set after on_begin_layer and reset after on_end_layer.

layer_info_b

Signature: [const] LayerInfo layer_info_b

Description: Gets the current layer properties for the second layout

This attribute is the current cell and is set after on_begin_layer and reset after on_end_layer.

layout_a

Signature: [const] const Layout ptr layout_a

Description: Gets the first layout the difference detector runs on

layout_b

Signature: [const] const Layout ptr layout_b

Description: Gets the second layout the difference detector runs on

new

Signature: [static] new LayoutDiff ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.

on_bbox_differs

Signature: [signal] void on_bbox_differs (const Box ba, const Box bb)

Description: This signal indicates a difference in the bounding boxes of two cells

This signal is only emitted in non-verbose mode (without Verbose flag) as a summarizing cell property. In verbose mode detailed events will be issued indicating the differences.

Python specific notes:
The object exposes a readable attribute 'on_bbox_differs'. This is the getter.
The object exposes a writable attribute 'on_bbox_differs'. This is the setter.

on_begin_box_differences

Signature: [signal] void on_begin_box_differences

Description: This signal indicates differences in the boxes on the current layer

The current layer is indicated by the begin_layer_event signal or can be obtained from the diff object through LayoutDiff#layer_info_a, LayoutDiff#layer_index_a, LayoutDiff#layer_info_b and LayoutDiff#layer_index_b. In verbose mode (see Verbose flag) more signals will be emitted for boxes that are different between the two layouts.

Python specific notes:
The object exposes a readable attribute 'on_begin_box_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_box_differences'. This is the setter.

on_begin_cell

Signature: [signal] void on_begin_cell (const Cell ptr ca, const Cell ptr cb)

Description: This signal indicates the sequence of events for a cell pair

All cell specific events happen between begin_cell_event and end_cell_event signals.

Python specific notes:
The object exposes a readable attribute 'on_begin_cell'. This is the getter.
The object exposes a writable attribute 'on_begin_cell'. This is the setter.

on_begin_edge_differences

Signature: [signal] void on_begin_edge_differences

Description: This signal indicates differences in the edges on the current layer

Python specific notes:
The object exposes a readable attribute 'on_begin_edge_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_edge_differences'. This is the setter.

on_begin_edge_pair_differences

Signature: [signal] void on_begin_edge_pair_differences

Description: This signal indicates differences in the edge pairs on the current layer

Python specific notes:
The object exposes a readable attribute 'on_begin_edge_pair_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_edge_pair_differences'. This is the setter.

on_begin_inst_differences

Signature: [signal] void on_begin_inst_differences

Description: This signal indicates differences in the cell instances

In verbose mode (see Verbose) more events will follow that indicate the instances that are present only in the first and second layout (instance_in_a_only_event and instance_in_b_only_event).

Python specific notes:
The object exposes a readable attribute 'on_begin_inst_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_inst_differences'. This is the setter.

on_begin_layer

Signature: [signal] void on_begin_layer (const LayerInfo layer, int layer_index_a, int layer_index_b)

Description: This signal indicates differences on the given layer

In verbose mode (see Verbose) more events will follow that indicate the instances that are present only in the first and second layout (polygon_in_a_only_event, polygon_in_b_only_event and similar).

Python specific notes:
The object exposes a readable attribute 'on_begin_layer'. This is the getter.
The object exposes a writable attribute 'on_begin_layer'. This is the setter.

on_begin_path_differences

Signature: [signal] void on_begin_path_differences

Description: This signal indicates differences in the paths on the current layer

Python specific notes:
The object exposes a readable attribute 'on_begin_path_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_path_differences'. This is the setter.

on_begin_polygon_differences

Signature: [signal] void on_begin_polygon_differences

Description: This signal indicates differences in the polygons on the current layer

Python specific notes:
The object exposes a readable attribute 'on_begin_polygon_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_polygon_differences'. This is the setter.

on_begin_text_differences

Signature: [signal] void on_begin_text_differences

Description: This signal indicates differences in the texts on the current layer

Python specific notes:
The object exposes a readable attribute 'on_begin_text_differences'. This is the getter.
The object exposes a writable attribute 'on_begin_text_differences'. This is the setter.

on_box_in_a_only

Signature: [signal] void on_box_in_a_only (const Box anotb, unsigned long prop_id)

Description: This signal indicates a box that is present in the first layout only

Python specific notes:
The object exposes a readable attribute 'on_box_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_box_in_a_only'. This is the setter.

on_box_in_b_only

Signature: [signal] void on_box_in_b_only (const Box bnota, unsigned long prop_id)

Description: This signal indicates a box that is present in the second layout only

Python specific notes:
The object exposes a readable attribute 'on_box_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_box_in_b_only'. This is the setter.

on_cell_in_a_only

Signature: [signal] void on_cell_in_a_only (const Cell ptr c)

Description: This signal indicates that the given cell is only present in the first layout

Python specific notes:
The object exposes a readable attribute 'on_cell_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_cell_in_a_only'. This is the setter.

on_cell_in_b_only

Signature: [signal] void on_cell_in_b_only (const Cell ptr c)

Description: This signal indicates that the given cell is only present in the second layout

Python specific notes:
The object exposes a readable attribute 'on_cell_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_cell_in_b_only'. This is the setter.

on_cell_meta_info_differs

Signature: [signal] void on_cell_meta_info_differs (string name, variant a, variant b)

Description: This signal indicates that meta info between the current cells differs

Meta information is only compared when WithMetaInfo is added to the compare flags. 'a' and 'b' are the values for the first and second layout. 'nil' is passed to these values to indicate missing meta information on one side.

This event has been added in version 0.28.16.

Python specific notes:
The object exposes a readable attribute 'on_cell_meta_info_differs'. This is the getter.
The object exposes a writable attribute 'on_cell_meta_info_differs'. This is the setter.

on_cell_name_differs

Signature: [signal] void on_cell_name_differs (const Cell ptr ca, const Cell ptr cb)

Description: This signal indicates a difference in the cell names

This signal is emitted in 'smart cell mapping' mode (see SmartCellMapping) if two cells are considered identical, but have different names.

Python specific notes:
The object exposes a readable attribute 'on_cell_name_differs'. This is the getter.
The object exposes a writable attribute 'on_cell_name_differs'. This is the setter.

on_dbu_differs

Signature: [signal] void on_dbu_differs (double dbu_a, double dbu_b)

Description: This signal indicates a difference in the database units of the layouts

Python specific notes:
The object exposes a readable attribute 'on_dbu_differs'. This is the getter.
The object exposes a writable attribute 'on_dbu_differs'. This is the setter.

on_edge_in_a_only

Signature: [signal] void on_edge_in_a_only (const Edge anotb, unsigned long prop_id)

Description: This signal indicates an edge that is present in the first layout only

Python specific notes:
The object exposes a readable attribute 'on_edge_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_edge_in_a_only'. This is the setter.

on_edge_in_b_only

Signature: [signal] void on_edge_in_b_only (const Edge bnota, unsigned long prop_id)

Description: This signal indicates an edge that is present in the second layout only

Python specific notes:
The object exposes a readable attribute 'on_edge_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_edge_in_b_only'. This is the setter.

on_edge_pair_in_a_only

Signature: [signal] void on_edge_pair_in_a_only (const EdgePair anotb, unsigned long prop_id)

Description: This signal indicates an edge pair that is present in the first layout only

This event has been introduced in version 0.28.

Python specific notes:
The object exposes a readable attribute 'on_edge_pair_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_edge_pair_in_a_only'. This is the setter.

on_edge_pair_in_b_only

Signature: [signal] void on_edge_pair_in_b_only (const EdgePair bnota, unsigned long prop_id)

Description: This signal indicates an edge pair that is present in the second layout only

This event has been introduced in version 0.28.

Python specific notes:
The object exposes a readable attribute 'on_edge_pair_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_edge_pair_in_b_only'. This is the setter.

on_end_box_differences

Signature: [signal] void on_end_box_differences

Description: This signal indicates the end of sequence of box differences

Python specific notes:
The object exposes a readable attribute 'on_end_box_differences'. This is the getter.
The object exposes a writable attribute 'on_end_box_differences'. This is the setter.

on_end_cell

Signature: [signal] void on_end_cell

Description: This signal indicates the end of a sequence of signals for a specific cell

Python specific notes:
The object exposes a readable attribute 'on_end_cell'. This is the getter.
The object exposes a writable attribute 'on_end_cell'. This is the setter.

on_end_edge_differences

Signature: [signal] void on_end_edge_differences

Description: This signal indicates the end of sequence of edge differences

Python specific notes:
The object exposes a readable attribute 'on_end_edge_differences'. This is the getter.
The object exposes a writable attribute 'on_end_edge_differences'. This is the setter.

on_end_edge_pair_differences

Signature: [signal] void on_end_edge_pair_differences

Description: This signal indicates the end of sequence of edge pair differences

This event has been introduced in version 0.28.

Python specific notes:
The object exposes a readable attribute 'on_end_edge_pair_differences'. This is the getter.
The object exposes a writable attribute 'on_end_edge_pair_differences'. This is the setter.

on_end_inst_differences

Signature: [signal] void on_end_inst_differences

Description: This signal finishes a sequence of detailed instance difference events

Python specific notes:
The object exposes a readable attribute 'on_end_inst_differences'. This is the getter.
The object exposes a writable attribute 'on_end_inst_differences'. This is the setter.

on_end_layer

Signature: [signal] void on_end_layer

Description: This signal indicates the end of a sequence of signals for a specific layer

Python specific notes:
The object exposes a readable attribute 'on_end_layer'. This is the getter.
The object exposes a writable attribute 'on_end_layer'. This is the setter.

on_end_path_differences

Signature: [signal] void on_end_path_differences

Description: This signal indicates the end of sequence of path differences

Python specific notes:
The object exposes a readable attribute 'on_end_path_differences'. This is the getter.
The object exposes a writable attribute 'on_end_path_differences'. This is the setter.

on_end_polygon_differences

Signature: [signal] void on_end_polygon_differences

Description: This signal indicates the end of sequence of polygon differences

Python specific notes:
The object exposes a readable attribute 'on_end_polygon_differences'. This is the getter.
The object exposes a writable attribute 'on_end_polygon_differences'. This is the setter.

on_end_text_differences

Signature: [signal] void on_end_text_differences

Description: This signal indicates the end of sequence of text differences

Python specific notes:
The object exposes a readable attribute 'on_end_text_differences'. This is the getter.
The object exposes a writable attribute 'on_end_text_differences'. This is the setter.

on_instance_in_a_only

Signature: [signal] void on_instance_in_a_only (const CellInstArray anotb, unsigned long prop_id)

Description: This signal indicates an instance that is present only in the first layout

This event is only emitted in verbose mode (Verbose flag).

Python specific notes:
The object exposes a readable attribute 'on_instance_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_instance_in_a_only'. This is the setter.

on_instance_in_b_only

Signature: [signal] void on_instance_in_b_only (const CellInstArray bnota, unsigned long prop_id)

Description: This signal indicates an instance that is present only in the second layout

This event is only emitted in verbose mode (Verbose flag).

Python specific notes:
The object exposes a readable attribute 'on_instance_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_instance_in_b_only'. This is the setter.

on_layer_in_a_only

Signature: [signal] void on_layer_in_a_only (const LayerInfo a)

Description: This signal indicates a layer that is present only in the first layout

Python specific notes:
The object exposes a readable attribute 'on_layer_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_layer_in_a_only'. This is the setter.

on_layer_in_b_only

Signature: [signal] void on_layer_in_b_only (const LayerInfo b)

Description: This signal indicates a layer that is present only in the second layout

Python specific notes:
The object exposes a readable attribute 'on_layer_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_layer_in_b_only'. This is the setter.

on_layer_name_differs

Signature: [signal] void on_layer_name_differs (const LayerInfo a, const LayerInfo b)

Description: This signal indicates a difference in the layer names

Python specific notes:
The object exposes a readable attribute 'on_layer_name_differs'. This is the getter.
The object exposes a writable attribute 'on_layer_name_differs'. This is the setter.

on_layout_meta_info_differs

Signature: [signal] void on_layout_meta_info_differs (string name, variant a, variant b)

Description: This signal indicates that global meta info differs

This event has been added in version 0.28.16.

Python specific notes:
The object exposes a readable attribute 'on_layout_meta_info_differs'. This is the getter.
The object exposes a writable attribute 'on_layout_meta_info_differs'. This is the setter.

on_path_in_a_only

Signature: [signal] void on_path_in_a_only (const Path anotb, unsigned long prop_id)

Description: This signal indicates a path that is present in the first layout only

Python specific notes:
The object exposes a readable attribute 'on_path_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_path_in_a_only'. This is the setter.

on_path_in_b_only

Signature: [signal] void on_path_in_b_only (const Path bnota, unsigned long prop_id)

Description: This signal indicates a path that is present in the second layout only

Python specific notes:
The object exposes a readable attribute 'on_path_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_path_in_b_only'. This is the setter.

on_per_layer_bbox_differs

Signature: [signal] void on_per_layer_bbox_differs (const Box ba, const Box bb)

Description: This signal indicates differences in the per-layer bounding boxes of the current cell

Python specific notes:
The object exposes a readable attribute 'on_per_layer_bbox_differs'. This is the getter.
The object exposes a writable attribute 'on_per_layer_bbox_differs'. This is the setter.

on_polygon_in_a_only

Signature: [signal] void on_polygon_in_a_only (const Polygon anotb, unsigned long prop_id)

Description: This signal indicates a polygon that is present in the first layout only

Python specific notes:
The object exposes a readable attribute 'on_polygon_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_polygon_in_a_only'. This is the setter.

on_polygon_in_b_only

Signature: [signal] void on_polygon_in_b_only (const Polygon bnota, unsigned long prop_id)

Description: This signal indicates a polygon that is present in the second layout only

Python specific notes:
The object exposes a readable attribute 'on_polygon_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_polygon_in_b_only'. This is the setter.

on_text_in_a_only

Signature: [signal] void on_text_in_a_only (const Text anotb, unsigned long prop_id)

Description: This signal indicates a text that is present in the first layout only

Python specific notes:
The object exposes a readable attribute 'on_text_in_a_only'. This is the getter.
The object exposes a writable attribute 'on_text_in_a_only'. This is the setter.

on_text_in_b_only

Signature: [signal] void on_text_in_b_only (const Text bnota, unsigned long prop_id)

Description: This signal indicates a text that is present in the second layout only

Python specific notes:
The object exposes a readable attribute 'on_text_in_b_only'. This is the getter.
The object exposes a writable attribute 'on_text_in_b_only'. This is the setter.