API reference - Class NetlistBrowserDialog

_const_cast

Signature: [const] NetlistBrowserDialog ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

current_path

Signature: [const] NetlistObjectsPath current_path

Description: Gets the path of the current object as a path pair (combines layout and schematic object paths in case of a LVS database view).

current_path_first

Signature: NetlistObjectPath current_path_first

Description: Gets the path of the current object on the first (layout in case of LVS database) side.

current_path_second

Signature: NetlistObjectPath current_path_second

Description: Gets the path of the current object on the second (schematic in case of LVS database) side.

db

Signature: LayoutToNetlist ptr db

Description: Gets the database the browser is connected to.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

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.

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.

new

Signature: [static] new NetlistBrowserDialog ptr new

Description: Creates a new object of this class

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

on_current_db_changed

Signature: [signal] void on_current_db_changed

Description: This event is triggered when the current database is changed.

The current database can be obtained with db.

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

on_probe

Signature: [signal] void on_probe (NetlistObjectPath first_path, NetlistObjectPath second_path)

Description: This event is triggered when a net is probed.

The first path will indicate the location of the probed net in terms of two paths: one describing the instantiation of the net in layout space and one in schematic space. Both objects are NetlistObjectPath objects which hold the root circuit, the chain of subcircuits leading to the circuit containing the net and the net itself.

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

on_selection_changed

Signature: [signal] void on_selection_changed

Description: This event is triggered when the selection changed.

The selection can be obtained with current_path_first, current_path_second, selected_nets, selected_devices, selected_subcircuits and selected_circuits.

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

selected_paths

Signature: [const] NetlistObjectsPath[] selected_paths

Description: Gets the nets currently selected objects (paths) in the netlist database browser.

The result is an array of path pairs. See NetlistObjectsPath for details about these pairs.