KLayout 0.30.4 (2025-09-11 8b0a8c731) [master]

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

API reference - Class ViaType

Module: db

Description: Describes a via type

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

These objects are used by PCellDeclaration#via_types to specify the via types a via PCell is able to provide.

The basic parameters of a via type are bottom and top layers (the layers that are connected by the via) and width and height. Width and height are the dimensions of the core via area - that is the part where bottom and top layers overlap. The actual layout may exceed these dimensions if different enclosure rules require so for example.

This class has been introduced in version 0.30.

Public constructors

new ViaType ptr

new

(string name,
string description = )

Creates a new via type object with the given name and description.

Public methods

[const]	ViaType ptr	_const_cast		Returns a non-const reference to self.
	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 ViaType other)	Assigns another object to self
[const]	LayerInfo	bottom		The bottom layer of the via.
	void	bottom=	(const LayerInfo value)	The bottom layer of the via.
[const]	double	bottom_grid		If non-zero, the bottom layer's dimensions will be rounded to this grid.
	void	bottom_grid=	(double value)	If non-zero, the bottom layer's dimensions will be rounded to this grid.
[const]	LayerInfo	cut		The cut layer of the via.
	void	cut=	(const LayerInfo value)	The cut layer of the via.
[const]	string	description		The description of the via type.
	void	description=	(string value)	The description of the via type.
[const]	new ViaType ptr	dup		Creates a copy of self
[const]	double	hbmin		The minimum bottom-layer height of the via.
	void	hbmin=	(double value)	The minimum bottom-layer height of the via.
[const]	double	htmin		The minimum top-layer height of the via.
	void	htmin=	(double value)	The minimum top-layer height of the via.
[const]	string	name		The formal name of the via type.
	void	name=	(string value)	The formal name of the via type.
[const]	LayerInfo	top		The top layer of the via.
	void	top=	(const LayerInfo value)	The top layer of the via.
[const]	double	top_grid		If non-zero, the top layer's dimensions will be rounded to this grid.
	void	top_grid=	(double value)	If non-zero, the top layer's dimensions will be rounded to this grid.
[const]	double	wbmin		The minimum bottom-layer width of the via.
	void	wbmin=	(double value)	The minimum bottom-layer width of the via.
[const]	double	wtmin		The minimum top-layer width of the via.
	void	wtmin=	(double value)	The minimum top-layer width of the via.

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

_const_cast	Signature: [const] ViaType 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.
assign	Signature: void assign (const ViaType other) Description: Assigns another object to self
bottom	Signature: [const] LayerInfo bottom Description: The bottom layer of the via. Python specific notes: The object exposes a readable attribute 'bottom'. This is the getter.
bottom=	Signature: void bottom= (const LayerInfo value) Description: The bottom layer of the via. Python specific notes: The object exposes a writable attribute 'bottom'. This is the setter.
bottom_grid	Signature: [const] double bottom_grid Description: If non-zero, the bottom layer's dimensions will be rounded to this grid. Python specific notes: The object exposes a readable attribute 'bottom_grid'. This is the getter.
bottom_grid=	Signature: void bottom_grid= (double value) Description: If non-zero, the bottom layer's dimensions will be rounded to this grid. Python specific notes: The object exposes a writable attribute 'bottom_grid'. This is the setter.
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.
cut	Signature: [const] LayerInfo cut Description: The cut layer of the via. Python specific notes: The object exposes a readable attribute 'cut'. This is the getter.
cut=	Signature: void cut= (const LayerInfo value) Description: The cut layer of the via. Python specific notes: The object exposes a writable attribute 'cut'. This is the setter.
description	Signature: [const] string description Description: The description of the via type. The description is an optional free-style text that describes the via type for a human. Python specific notes: The object exposes a readable attribute 'description'. This is the getter.
description=	Signature: void description= (string value) Description: The description of the via type. The description is an optional free-style text that describes the via type for a human. Python specific notes: The object exposes a writable attribute 'description'. This is the setter.
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.
dup	Signature: [const] new ViaType ptr dup Description: Creates a copy of self Python specific notes: This method also implements '__copy__' and '__deepcopy__'.
hbmin	Signature: [const] double hbmin Description: The minimum bottom-layer height of the via. This values specifies the minimum height of the bottom layer in micrometers. The default is zero. Python specific notes: The object exposes a readable attribute 'hbmin'. This is the getter.
hbmin=	Signature: void hbmin= (double value) Description: The minimum bottom-layer height of the via. This values specifies the minimum height of the bottom layer in micrometers. The default is zero. Python specific notes: The object exposes a writable attribute 'hbmin'. This is the setter.
htmin	Signature: [const] double htmin Description: The minimum top-layer height of the via. This values specifies the minimum height of the top layer in micrometers. The default is zero. Python specific notes: The object exposes a readable attribute 'htmin'. This is the getter.
htmin=	Signature: void htmin= (double value) Description: The minimum top-layer height of the via. This values specifies the minimum height of the top layer in micrometers. The default is zero. Python specific notes: The object exposes a writable attribute 'htmin'. This is the setter.
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.
name	Signature: [const] string name Description: The formal name of the via type. The name should be unique and identify the via type in the context of the via declaration. Python specific notes: The object exposes a readable attribute 'name'. This is the getter.
name=	Signature: void name= (string value) Description: The formal name of the via type. The name should be unique and identify the via type in the context of the via declaration. Python specific notes: The object exposes a writable attribute 'name'. This is the setter.
new	Signature: [static] new ViaType ptr new (string name, string description = ) Description: Creates a new via type object with the given name and description. Python specific notes: This method is the default initializer of the object.
top	Signature: [const] LayerInfo top Description: The top layer of the via. Python specific notes: The object exposes a readable attribute 'top'. This is the getter.
top=	Signature: void top= (const LayerInfo value) Description: The top layer of the via. Python specific notes: The object exposes a writable attribute 'top'. This is the setter.
top_grid	Signature: [const] double top_grid Description: If non-zero, the top layer's dimensions will be rounded to this grid. Python specific notes: The object exposes a readable attribute 'top_grid'. This is the getter.
top_grid=	Signature: void top_grid= (double value) Description: If non-zero, the top layer's dimensions will be rounded to this grid. Python specific notes: The object exposes a writable attribute 'top_grid'. This is the setter.
wbmin	Signature: [const] double wbmin Description: The minimum bottom-layer width of the via. This values specifies the minimum width of the bottom layer in micrometers. The default is zero. Python specific notes: The object exposes a readable attribute 'wbmin'. This is the getter.
wbmin=	Signature: void wbmin= (double value) Description: The minimum bottom-layer width of the via. This values specifies the minimum width of the bottom layer in micrometers. The default is zero. Python specific notes: The object exposes a writable attribute 'wbmin'. This is the setter.
wtmin	Signature: [const] double wtmin Description: The minimum top-layer width of the via. This values specifies the minimum width of the top layer in micrometers. The default is zero. Python specific notes: The object exposes a readable attribute 'wtmin'. This is the getter.
wtmin=	Signature: void wtmin= (double value) Description: The minimum top-layer width of the via. This values specifies the minimum width of the top layer in micrometers. The default is zero. Python specific notes: The object exposes a writable attribute 'wtmin'. This is the setter.

API reference - Class ViaType

Public constructors

Public methods

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

Detailed description

_const_cast

_create

_destroy

_destroyed?

_is_const_object?

_manage

_unmanage

assign

bottom

bottom=

bottom_grid

bottom_grid=

create

cut

cut=

description

description=

destroy

destroyed?

dup

hbmin

hbmin=

htmin

htmin=

is_const_object?

name

name=

new

top

top=

top_grid

top_grid=

wbmin

wbmin=

wtmin

wtmin=