mirror of https://github.com/KLayout/klayout.git
Refreshing stubs
This commit is contained in:
Matthias Koefferlein
parent
99e79488b6
commit
f1cc048a4c
|
|
@ -4588,22 +4588,25 @@ class Circuit(NetlistObject):
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def nets_by_name(self, name_pattern: str) -> List[Net]:
|
||||
def nets_by_name(self, name_pattern: str, case_sensitive: Optional[Any] = ...) -> List[Net]:
|
||||
r"""
|
||||
@brief Gets the net objects for a given name filter.
|
||||
The name filter is a glob pattern. This method will return all \Net objects matching the glob pattern.
|
||||
The 'case_sensitive' argument will control whether the name is looked up in a case sensitive way or not. Note that with case insensitive search on a netlist that is case sensitive, the same name may render more than one hit. By default, case sensitivity is taken from the netlist.
|
||||
|
||||
This method has been introduced in version 0.27.3.
|
||||
The 'case_sensitive' argument has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def nets_by_name(self, name_pattern: str) -> List[Net]:
|
||||
def nets_by_name(self, name_pattern: str, case_sensitive: Optional[Any] = ...) -> List[Net]:
|
||||
r"""
|
||||
@brief Gets the net objects for a given name filter (const version).
|
||||
The name filter is a glob pattern. This method will return all \Net objects matching the glob pattern.
|
||||
The 'case_sensitive' argument will control whether the name is looked up in a case sensitive way or not. Note that with case insensitive search on a netlist that is case sensitive, the same name may render more than one hit. By default, case sensitivity is taken from the netlist.
|
||||
|
||||
|
||||
This constness variant has been introduced in version 0.27.3
|
||||
This constness variant has been introduced in version 0.27.3.
|
||||
The 'case_sensitive' argument has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
|
|
@ -15645,7 +15648,8 @@ class DText:
|
|||
Setter:
|
||||
@brief Sets the horizontal alignment
|
||||
|
||||
This is the version accepting integer values. It's provided for backward compatibility.
|
||||
This property specifies how the text is aligned relative to the anchor point.
|
||||
This property has been introduced in version 0.22 and extended to enums in 0.28.
|
||||
"""
|
||||
size: float
|
||||
r"""
|
||||
|
|
@ -15681,7 +15685,8 @@ class DText:
|
|||
Setter:
|
||||
@brief Sets the vertical alignment
|
||||
|
||||
This is the version accepting integer values. It's provided for backward compatibility.
|
||||
This property specifies how the text is aligned relative to the anchor point.
|
||||
This property has been introduced in version 0.22 and extended to enums in 0.28.
|
||||
"""
|
||||
x: float
|
||||
r"""
|
||||
|
|
@ -16438,13 +16443,13 @@ class DTrans:
|
|||
Getter:
|
||||
@brief Gets to the displacement vector
|
||||
|
||||
Staring with version 0.25 the displacement type is a vector.
|
||||
Starting with version 0.25 the displacement type is a vector.
|
||||
Setter:
|
||||
@brief Sets the displacement
|
||||
@param u The new displacement
|
||||
|
||||
This method was introduced in version 0.20.
|
||||
Staring with version 0.25 the displacement type is a vector.
|
||||
Starting with version 0.25 the displacement type is a vector.
|
||||
"""
|
||||
mirror: bool
|
||||
r"""
|
||||
|
|
@ -34958,11 +34963,11 @@ class Instance:
|
|||
|
||||
Starting with version 0.25 the displacement is of vector type.
|
||||
Setter:
|
||||
@brief Sets the displacement vector for the 'b' axis
|
||||
@brief Sets the displacement vector for the 'b' axis in micrometer units
|
||||
|
||||
If the instance was not an array instance before it is made one.
|
||||
Like \b= with an integer displacement, this method will set the displacement vector but it accepts a vector in micrometer units that is of \DVector type. The vector will be translated to database units internally.
|
||||
|
||||
This method has been introduced in version 0.23. Starting with version 0.25 the displacement is of vector type.
|
||||
This method has been introduced in version 0.25.
|
||||
"""
|
||||
cell: Cell
|
||||
r"""
|
||||
|
|
@ -35005,9 +35010,10 @@ class Instance:
|
|||
@brief Gets the complex transformation of the instance or the first instance in the array
|
||||
This method is always valid compared to \trans, since simple transformations can be expressed as complex transformations as well.
|
||||
Setter:
|
||||
@brief Sets the complex transformation of the instance or the first instance in the array
|
||||
@brief Sets the complex transformation of the instance or the first instance in the array (in micrometer units)
|
||||
This method sets the transformation the same way as \cplx_trans=, but the displacement of this transformation is given in micrometer units. It is internally translated into database units.
|
||||
|
||||
This method has been introduced in version 0.23.
|
||||
This method has been introduced in version 0.25.
|
||||
"""
|
||||
da: DVector
|
||||
r"""
|
||||
|
|
@ -35723,6 +35729,13 @@ class LEFDEFReaderConfiguration:
|
|||
See \dbu for details.
|
||||
"""
|
||||
@property
|
||||
def lef_context_enabled(self) -> None:
|
||||
r"""
|
||||
WARNING: This variable can only be set, not retrieved.
|
||||
@hide
|
||||
"""
|
||||
...
|
||||
@property
|
||||
def paths_relative_to_cwd(self) -> None:
|
||||
r"""
|
||||
WARNING: This variable can only be set, not retrieved.
|
||||
|
|
@ -41693,6 +41706,12 @@ class LayoutToNetlist:
|
|||
Usually it's not required to call this method. It has been introduced in version 0.24.
|
||||
"""
|
||||
...
|
||||
def add_log_entry(self, entry: LogEntryData) -> None:
|
||||
r"""
|
||||
@brief Adds a log entry.
|
||||
This method has been introduced in version 0.30.2
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def antenna_check(self, gate: Region, gate_area_factor: float, gate_perimeter_factor: float, metal: Region, metal_area_factor: float, metal_perimeter_factor: float, ratio: float, diodes: Optional[Sequence[Any]] = ..., texts: Optional[Texts] = ...) -> Region:
|
||||
r"""
|
||||
|
|
@ -41781,7 +41800,7 @@ class LayoutToNetlist:
|
|||
|
||||
'lmap' defines which layers are to be produced. It is map, where the keys are layer indexes in the target layout and the values are Region or Texts objects or layer indexes, indicating the layer where shapes are to be taken from. 'lmap' can also be left nil, in which case, a layer mapping will be provided based on the layer info attributes of the layers (see \layer_info).
|
||||
|
||||
'cmap' specifies the cell mapping. Use \create_cell_mapping or \const_create_cell_mapping to define the target cells in the target layout and to derive a cell mapping.
|
||||
'cmap' specifies the cell mapping. Use \cell_mapping_into or \const_cell_mapping_into to define the target cells in the target layout and to derive a cell mapping.
|
||||
|
||||
The method has three net annotation modes:
|
||||
@ul
|
||||
|
|
@ -41899,6 +41918,12 @@ class LayoutToNetlist:
|
|||
Explicit net joining has been introduced in version 0.27.
|
||||
"""
|
||||
...
|
||||
def clear_log_entries(self) -> None:
|
||||
r"""
|
||||
@brief Clears the log entries.
|
||||
This method has been introduced in version 0.30.2
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def connect(self, a: Region, b: Region) -> None:
|
||||
r"""
|
||||
|
|
@ -42841,6 +42866,18 @@ class LayoutVsSchematic(LayoutToNetlist):
|
|||
@brief Compare the layout-extracted netlist against the reference netlist using the given netlist comparer.
|
||||
"""
|
||||
...
|
||||
def flag_missing_ports(self, circuit: Circuit) -> bool:
|
||||
r"""
|
||||
@brief Flags inconsistent port labels in the given circuit
|
||||
@param circuit Either a layout or schematic circuit
|
||||
@return True, if no errors were found
|
||||
This method will check all schematic nets which have pins and tests whether the corresponding layout net has the same name. This way, it is checked if the pins are properly labelled.
|
||||
|
||||
The method must be called after the compare step was successful. Error messages will be added to the log entries. If an error occured or the cross reference is not value, 'false' is returned.
|
||||
|
||||
This method was introduced in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
def read(self, path: str) -> None:
|
||||
r"""
|
||||
@brief Reads the LVS object from the file.
|
||||
|
|
@ -43787,6 +43824,51 @@ class LoadLayoutOptions:
|
|||
|
||||
This method has been added in version 0.26.2.
|
||||
"""
|
||||
maly_create_other_layers: bool
|
||||
r"""
|
||||
Getter:
|
||||
@brief Gets a value indicating whether other layers shall be created
|
||||
@return True, if other layers will be created.
|
||||
This attribute acts together with a layer map (see \maly_layer_map=). Layers not listed in this map are created as well when \maly_create_other_layers? is true. Otherwise they are ignored.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
Setter:
|
||||
@brief Specifies whether other layers shall be created
|
||||
@param create True, if other layers will be created.
|
||||
See \maly_create_other_layers? for a description of this attribute.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
maly_dbu: float
|
||||
r"""
|
||||
Getter:
|
||||
@brief Specifies the database unit which the reader uses and produces
|
||||
See \maly_dbu= method for a description of this property.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
Setter:
|
||||
@brief Specifies the database unit which the reader uses and produces
|
||||
The database unit is the final resolution of the produced layout. This physical resolution is usually defined by the layout system - GDS for example typically uses 1nm (maly_dbu=0.001).
|
||||
All geometry in the MALY pattern files is brought to the database unit by scaling.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
maly_layer_map: LayerMap
|
||||
r"""
|
||||
Getter:
|
||||
@brief Gets the layer map
|
||||
@return A reference to the layer map
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
Setter:
|
||||
@brief Sets the layer map
|
||||
This sets a layer mapping for the reader. Unlike \maly_set_layer_map, the 'create_other_layers' flag is not changed.
|
||||
@param map The layer map to set.
|
||||
|
||||
Layer maps can also be used to map the named MALY mask layers to GDS layer/datatypes.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
mebes_boundary_datatype: int
|
||||
r"""
|
||||
Getter:
|
||||
|
|
@ -44224,6 +44306,28 @@ class LoadLayoutOptions:
|
|||
This method has been added in version 0.26.2.
|
||||
"""
|
||||
...
|
||||
def maly_select_all_layers(self) -> None:
|
||||
r"""
|
||||
@brief Selects all layers and disables the layer map
|
||||
|
||||
This disables any layer map and enables reading of all layers.
|
||||
New layers will be created when required.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
def maly_set_layer_map(self, map: LayerMap, create_other_layers: bool) -> None:
|
||||
r"""
|
||||
@brief Sets the layer map
|
||||
This sets a layer mapping for the reader. The layer map allows selection and translation of the original layers, for example to assign layer/datatype numbers to the named layers.
|
||||
@param map The layer map to set.
|
||||
@param create_other_layers The flag indicating whether other layers will be created as well. Set to false to read only the layers in the layer map.
|
||||
|
||||
Layer maps can also be used to map the named MALY mask layers to GDS layer/datatypes.
|
||||
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
def mebes_select_all_layers(self) -> None:
|
||||
r"""
|
||||
@brief Selects all layers and disables the layer map
|
||||
|
|
@ -46439,15 +46543,15 @@ class NetPinRef:
|
|||
@overload
|
||||
def net(self) -> Net:
|
||||
r"""
|
||||
@brief Gets the net this pin reference is attached to (non-const version).
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
@brief Gets the net this pin reference is attached to.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def net(self) -> Net:
|
||||
r"""
|
||||
@brief Gets the net this pin reference is attached to.
|
||||
@brief Gets the net this pin reference is attached to (non-const version).
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
"""
|
||||
...
|
||||
def pin(self) -> Pin:
|
||||
|
|
@ -46737,17 +46841,17 @@ class NetTerminalRef:
|
|||
@overload
|
||||
def device(self) -> Device:
|
||||
r"""
|
||||
@brief Gets the device reference.
|
||||
@brief Gets the device reference (non-const version).
|
||||
Gets the device object that this connection is made to.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def device(self) -> Device:
|
||||
r"""
|
||||
@brief Gets the device reference (non-const version).
|
||||
@brief Gets the device reference.
|
||||
Gets the device object that this connection is made to.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
"""
|
||||
...
|
||||
def device_class(self) -> DeviceClass:
|
||||
|
|
@ -46770,15 +46874,15 @@ class NetTerminalRef:
|
|||
@overload
|
||||
def net(self) -> Net:
|
||||
r"""
|
||||
@brief Gets the net this terminal reference is attached to.
|
||||
@brief Gets the net this terminal reference is attached to (non-const version).
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def net(self) -> Net:
|
||||
r"""
|
||||
@brief Gets the net this terminal reference is attached to (non-const version).
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
@brief Gets the net this terminal reference is attached to.
|
||||
"""
|
||||
...
|
||||
def terminal_def(self) -> DeviceTerminalDefinition:
|
||||
|
|
@ -47757,6 +47861,13 @@ class Netlist:
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit_by_name(self, name: str) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit object for a given name.
|
||||
If the name is not a valid circuit name, nil is returned.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit_by_name(self, name: str) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit object for a given name (const version).
|
||||
|
|
@ -47766,28 +47877,24 @@ class Netlist:
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit_by_name(self, name: str) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit object for a given name.
|
||||
If the name is not a valid circuit name, nil is returned.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def circuits_by_name(self, name_pattern: str) -> List[Circuit]:
|
||||
r"""
|
||||
@brief Gets the circuit objects for a given name filter.
|
||||
The name filter is a glob pattern. This method will return all \Circuit objects matching the glob pattern.
|
||||
|
||||
This method has been introduced in version 0.26.4.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def circuits_by_name(self, name_pattern: str) -> List[Circuit]:
|
||||
def circuits_by_name(self, name_pattern: str, case_sensitive: Optional[Any] = ...) -> List[Circuit]:
|
||||
r"""
|
||||
@brief Gets the circuit objects for a given name filter (const version).
|
||||
The name filter is a glob pattern. This method will return all \Circuit objects matching the glob pattern.
|
||||
The 'case_sensitive' argument will control whether the name is looked up in a case sensitive way or not. Note that with case insensitive search on a netlist that is case sensitive, the same name may render more than one hit. By default, case sensitivity is taken from the netlist.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8.
|
||||
This constness variant has been introduced in version 0.26.8.The 'case_sensitive' argument has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def circuits_by_name(self, name_pattern: str, case_sensitive: Optional[Any] = ...) -> List[Circuit]:
|
||||
r"""
|
||||
@brief Gets the circuit objects for a given name filter.
|
||||
The name filter is a glob pattern. This method will return all \Circuit objects matching the glob pattern.
|
||||
The 'case_sensitive' argument will control whether the name is looked up in a case sensitive way or not. Note that with case insensitive search on a netlist that is case sensitive, the same name may render more than one hit. By default, case sensitivity is taken from the netlist.
|
||||
|
||||
This method has been introduced in version 0.26.4.
|
||||
The 'case_sensitive' argument has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
def combine_devices(self) -> None:
|
||||
|
|
@ -47952,22 +48059,24 @@ class Netlist:
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def nets_by_name(self, name_pattern: str) -> List[Net]:
|
||||
def nets_by_name(self, name_pattern: str, case_sensitive: Optional[Any] = ...) -> List[Net]:
|
||||
r"""
|
||||
@brief Gets the net objects for a given name filter.
|
||||
The name filter is a glob pattern. This method will return all \Net objects matching the glob pattern.
|
||||
The 'case_sensitive' argument will control whether the name is looked up in a case sensitive way or not. Note that with case insensitive search on a netlist that is case sensitive, the same name may render more than one hit. By default, case sensitivity is taken from the netlist.
|
||||
|
||||
This method has been introduced in version 0.28.4.
|
||||
The 'case_sensitive' argument has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def nets_by_name(self, name_pattern: str) -> List[Net]:
|
||||
def nets_by_name(self, name_pattern: str, case_sensitive: Optional[Any] = ...) -> List[Net]:
|
||||
r"""
|
||||
@brief Gets the net objects for a given name filter (const version).
|
||||
The name filter is a glob pattern. This method will return all \Net objects matching the glob pattern.
|
||||
The 'case_sensitive' argument will control whether the name is looked up in a case sensitive way or not. Note that with case insensitive search on a netlist that is case sensitive, the same name may render more than one hit. By default, case sensitivity is taken from the netlist.
|
||||
|
||||
|
||||
This constness variant has been introduced in version 0.28.4.
|
||||
This constness variant has been introduced in version 0.28.4.The 'case_sensitive' argument has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
def purge(self) -> None:
|
||||
|
|
@ -48032,7 +48141,7 @@ class Netlist:
|
|||
@overload
|
||||
def top_circuit(self) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the top circuit (const version).
|
||||
@brief Gets the top circuit.
|
||||
This method will return nil, if there is no top circuit. It will raise an error, if there is more than a single top circuit.
|
||||
|
||||
This convenience method has been added in version 0.29.5.
|
||||
|
|
@ -48041,7 +48150,7 @@ class Netlist:
|
|||
@overload
|
||||
def top_circuit(self) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the top circuit.
|
||||
@brief Gets the top circuit (const version).
|
||||
This method will return nil, if there is no top circuit. It will raise an error, if there is more than a single top circuit.
|
||||
|
||||
This convenience method has been added in version 0.29.5.
|
||||
|
|
@ -48927,42 +49036,105 @@ class NetlistCrossReference(NetlistCompareLogger):
|
|||
See the class description for details.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_device_pair(self, circuit: Circuit) -> Iterator[NetlistCrossReference.DevicePairData]:
|
||||
r"""
|
||||
@brief Delivers the device pairs and their status for the given circuit pair.
|
||||
This convenience method looks up the circuit pair from the given circuit. This circuit can be a schematic or layout circuit.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_device_pair(self, circuit_pair: NetlistCrossReference.CircuitPairData) -> Iterator[NetlistCrossReference.DevicePairData]:
|
||||
r"""
|
||||
@brief Delivers the device pairs and their status for the given circuit pair.
|
||||
See the class description for details.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_pair(self, circuit: Circuit) -> Iterator[NetlistCrossReference.NetPairData]:
|
||||
r"""
|
||||
@brief Delivers the net pairs and their status for the given circuit.
|
||||
This convenience method looks up the circuit pair from the given circuit. This circuit can be a schematic or layout circuit.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_pair(self, circuit_pair: NetlistCrossReference.CircuitPairData) -> Iterator[NetlistCrossReference.NetPairData]:
|
||||
r"""
|
||||
@brief Delivers the net pairs and their status for the given circuit pair.
|
||||
See the class description for details.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_pin_pair(self, net: Net) -> Iterator[NetlistCrossReference.NetPinRefPair]:
|
||||
r"""
|
||||
@brief Delivers the pin pairs for the given net pair.
|
||||
This convenience method looks up the net pair from the given net. This net can be a schematic or layout net.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_pin_pair(self, net_pair: NetlistCrossReference.NetPairData) -> Iterator[NetlistCrossReference.NetPinRefPair]:
|
||||
r"""
|
||||
@brief Delivers the pin pairs for the given net pair.
|
||||
For the net pair, lists the pin pairs identified on this net.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_subcircuit_pin_pair(self, net: Net) -> Iterator[NetlistCrossReference.NetSubcircuitPinRefPair]:
|
||||
r"""
|
||||
@brief Delivers the subcircuit pin pairs for the given net pair.
|
||||
This convenience method looks up the net pair from the given net. This net can be a schematic or layout net.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_subcircuit_pin_pair(self, net_pair: NetlistCrossReference.NetPairData) -> Iterator[NetlistCrossReference.NetSubcircuitPinRefPair]:
|
||||
r"""
|
||||
@brief Delivers the subcircuit pin pairs for the given net pair.
|
||||
For the net pair, lists the subcircuit pin pairs identified on this net.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_terminal_pair(self, net: Net) -> Iterator[NetlistCrossReference.NetTerminalRefPair]:
|
||||
r"""
|
||||
@brief Delivers the device terminal pairs for the given net pair.
|
||||
This convenience method looks up the net pair from the given net. This net can be a schematic or layout net.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_net_terminal_pair(self, net_pair: NetlistCrossReference.NetPairData) -> Iterator[NetlistCrossReference.NetTerminalRefPair]:
|
||||
r"""
|
||||
@brief Delivers the device terminal pairs for the given net pair.
|
||||
For the net pair, lists the device terminal pairs identified on this net.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_pin_pair(self, circuit: Circuit) -> Iterator[NetlistCrossReference.PinPairData]:
|
||||
r"""
|
||||
@brief Delivers the pin pairs and their status for the given circuit pair.
|
||||
This convenience method looks up the circuit pair from the given circuit. This circuit can be a schematic or layout circuit.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_pin_pair(self, circuit_pair: NetlistCrossReference.CircuitPairData) -> Iterator[NetlistCrossReference.PinPairData]:
|
||||
r"""
|
||||
@brief Delivers the pin pairs and their status for the given circuit pair.
|
||||
See the class description for details.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_subcircuit_pair(self, circuit: Circuit) -> Iterator[NetlistCrossReference.SubCircuitPairData]:
|
||||
r"""
|
||||
@brief Delivers the subcircuit pairs and their status for the given circuit pair.
|
||||
This convenience method looks up the circuit pair from the given circuit. This circuit can be a schematic or layout circuit.
|
||||
This method has been added in version 0.30.2.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def each_subcircuit_pair(self, circuit_pair: NetlistCrossReference.CircuitPairData) -> Iterator[NetlistCrossReference.SubCircuitPairData]:
|
||||
r"""
|
||||
@brief Delivers the subcircuit pairs and their status for the given circuit pair.
|
||||
|
|
@ -54649,6 +54821,19 @@ class PolygonNeighborhoodVisitor(PolygonNeighborhoodVisitorBase):
|
|||
@brief Configures the result type
|
||||
Use this method to indicate what type of result you want to deliver. You can use the corresponding 'output' method then to deliver result shapes from one the callbacks (\on_edge, \begin_polygon, \end_polygon). Set this attribute when you create the visitor object. This attribute does not need to be set if no output is indended to be delivered.
|
||||
"""
|
||||
variant_type: VariantType
|
||||
r"""
|
||||
Getter:
|
||||
@brief Gets the variant type
|
||||
See \variant_type= for a description of this property.
|
||||
|
||||
This property was introduced in version 0.30.2.
|
||||
Setter:
|
||||
@brief Configures the variant type
|
||||
The variant type configures transformation variant formation. The polygons presented to the visitor are normalized to the given variant type. For example, specify \VariantType#Orientation to force orientation variants in the cell tree. Polygons presented to the visitor are normalized to 'as if top' orientation with this variant type.
|
||||
|
||||
This property was introduced in version 0.30.2.
|
||||
"""
|
||||
def _const_cast(self) -> PolygonNeighborhoodVisitor:
|
||||
r"""
|
||||
@brief Returns a non-const reference to self.
|
||||
|
|
@ -63057,12 +63242,11 @@ class Shape:
|
|||
This method has been introduced in version 0.23.
|
||||
|
||||
Setter:
|
||||
@brief Sets the lower left corner of the box with the point being given in micrometer units
|
||||
@brief Sets the lower left point of the box
|
||||
|
||||
Applies to boxes only. Changes the lower left point of the box and throws an exception if the shape is not a box.
|
||||
Translation from micrometer units to database units is done internally.
|
||||
|
||||
This method has been introduced in version 0.25.
|
||||
This method has been introduced in version 0.23.
|
||||
"""
|
||||
box_p2: Point
|
||||
r"""
|
||||
|
|
@ -63232,10 +63416,11 @@ class Shape:
|
|||
|
||||
Starting with version 0.23, this method returns nil, if the shape does not represent an edge.
|
||||
Setter:
|
||||
@brief Replaces the shape by the given edge (in micrometer units)
|
||||
This method replaces the shape by the given edge, like \edge= with a \Edge argument does. This version translates the edge from micrometer units to database units internally.
|
||||
@brief Replaces the shape by the given edge
|
||||
This method replaces the shape by the given edge. This method can only be called for editable layouts. It does not change the user properties of the shape.
|
||||
Calling this method will invalidate any iterators. It should not be called inside a loop iterating over shapes.
|
||||
|
||||
This method has been introduced in version 0.25.
|
||||
This method has been introduced in version 0.22.
|
||||
"""
|
||||
edge_pair: Any
|
||||
r"""
|
||||
|
|
@ -63452,11 +63637,10 @@ class Shape:
|
|||
|
||||
Starting with version 0.23, this method returns nil, if the shape does not represent a text.
|
||||
Setter:
|
||||
@brief Replaces the shape by the given text object
|
||||
This method replaces the shape by the given text object. This method can only be called for editable layouts. It does not change the user properties of the shape.
|
||||
Calling this method will invalidate any iterators. It should not be called inside a loop iterating over shapes.
|
||||
@brief Replaces the shape by the given text (in micrometer units)
|
||||
This method replaces the shape by the given text, like \text= with a \Text argument does. This version translates the text from micrometer units to database units internally.
|
||||
|
||||
This method has been introduced in version 0.22.
|
||||
This method has been introduced in version 0.25.
|
||||
"""
|
||||
text_dpos: DVector
|
||||
r"""
|
||||
|
|
@ -67636,15 +67820,6 @@ class SubCircuit(NetlistObject):
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit(self) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit the subcircuit lives in (non-const version).
|
||||
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit(self) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit the subcircuit lives in.
|
||||
|
|
@ -67652,9 +67827,12 @@ class SubCircuit(NetlistObject):
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit_ref(self) -> Circuit:
|
||||
def circuit(self) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit referenced by the subcircuit.
|
||||
@brief Gets the circuit the subcircuit lives in (non-const version).
|
||||
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
|
|
@ -67667,6 +67845,12 @@ class SubCircuit(NetlistObject):
|
|||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit_ref(self) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit referenced by the subcircuit.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def connect_pin(self, pin: Pin, net: Net) -> None:
|
||||
r"""
|
||||
@brief Connects the given pin to the specified net.
|
||||
|
|
@ -68369,8 +68553,7 @@ class Text:
|
|||
Setter:
|
||||
@brief Sets the vertical alignment
|
||||
|
||||
This property specifies how the text is aligned relative to the anchor point.
|
||||
This property has been introduced in version 0.22 and extended to enums in 0.28.
|
||||
This is the version accepting integer values. It's provided for backward compatibility.
|
||||
"""
|
||||
x: int
|
||||
r"""
|
||||
|
|
@ -71737,13 +71920,13 @@ class Trans:
|
|||
Getter:
|
||||
@brief Gets to the displacement vector
|
||||
|
||||
Staring with version 0.25 the displacement type is a vector.
|
||||
Starting with version 0.25 the displacement type is a vector.
|
||||
Setter:
|
||||
@brief Sets the displacement
|
||||
@param u The new displacement
|
||||
|
||||
This method was introduced in version 0.20.
|
||||
Staring with version 0.25 the displacement type is a vector.
|
||||
Starting with version 0.25 the displacement type is a vector.
|
||||
"""
|
||||
mirror: bool
|
||||
r"""
|
||||
|
|
@ -74758,6 +74941,251 @@ class VCplxTrans:
|
|||
...
|
||||
...
|
||||
|
||||
class VariantType:
|
||||
r"""
|
||||
@brief This class represents the cell variant type for various methods.
|
||||
|
||||
Cell variants are needed in hierarchical applications, when operations are to be performed on cell level, but the operations are not transformation invariant.
|
||||
In that case, a variant type needs to be specified in order to make the algorithm separate the cells by their absolute orientation or by their accumulated magnification.
|
||||
|
||||
This enum has been introduced in version 0.30.2.
|
||||
"""
|
||||
Magnification: ClassVar[VariantType]
|
||||
r"""
|
||||
@brief Scaling variants needed.
|
||||
For example, distance measurements or the isotropic sizing operations needs this variant type.
|
||||
"""
|
||||
MagnificationAndOrientation: ClassVar[VariantType]
|
||||
r"""
|
||||
@brief Scaling and orientation variants needed.
|
||||
For example, the 'move' operation needs this variant type.
|
||||
"""
|
||||
NoVariants: ClassVar[VariantType]
|
||||
r"""
|
||||
@brief No variants needed.
|
||||
"""
|
||||
Orientation: ClassVar[VariantType]
|
||||
r"""
|
||||
@brief Orientation variants needed.
|
||||
For example, the edge orientation selection operation needs this variant type.
|
||||
"""
|
||||
Orthogonal: ClassVar[VariantType]
|
||||
r"""
|
||||
@brief Orthogonal transformations (rotations by multiples of 90 degree) need variants.
|
||||
For example, the diagonal edge selection operation needs this variant type.
|
||||
"""
|
||||
XYAnisotropyAndMagnification: ClassVar[VariantType]
|
||||
r"""
|
||||
@brief Scaling and anisotropy variants needed.
|
||||
For example, the anisotropic sizing operation needs this variant type.
|
||||
"""
|
||||
@overload
|
||||
@classmethod
|
||||
def new(cls, i: int) -> VariantType:
|
||||
r"""
|
||||
@brief Creates an enum from an integer value
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
@classmethod
|
||||
def new(cls, s: str) -> VariantType:
|
||||
r"""
|
||||
@brief Creates an enum from a string value
|
||||
"""
|
||||
...
|
||||
def __copy__(self) -> VariantType:
|
||||
r"""
|
||||
@brief Creates a copy of self
|
||||
"""
|
||||
...
|
||||
def __deepcopy__(self) -> VariantType:
|
||||
r"""
|
||||
@brief Creates a copy of self
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __eq__(self, other: int) -> bool:
|
||||
r"""
|
||||
@brief Compares an enum with an integer value
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __eq__(self, other: object) -> bool:
|
||||
r"""
|
||||
@brief Compares two enums
|
||||
"""
|
||||
...
|
||||
def __hash__(self) -> int:
|
||||
r"""
|
||||
@brief Gets the hash value from the enum
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __init__(self, i: int) -> None:
|
||||
r"""
|
||||
@brief Creates an enum from an integer value
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __init__(self, s: str) -> None:
|
||||
r"""
|
||||
@brief Creates an enum from a string value
|
||||
"""
|
||||
...
|
||||
def __int__(self) -> int:
|
||||
r"""
|
||||
@brief Gets the integer value from the enum
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __lt__(self, other: VariantType) -> bool:
|
||||
r"""
|
||||
@brief Returns true if the first enum is less (in the enum symbol order) than the second
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __lt__(self, other: int) -> bool:
|
||||
r"""
|
||||
@brief Returns true if the enum is less (in the enum symbol order) than the integer value
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __ne__(self, other: int) -> bool:
|
||||
r"""
|
||||
@brief Compares an enum with an integer for inequality
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __ne__(self, other: object) -> bool:
|
||||
r"""
|
||||
@brief Compares two enums for inequality
|
||||
"""
|
||||
...
|
||||
def __repr__(self) -> str:
|
||||
r"""
|
||||
@brief Converts an enum to a visual string
|
||||
"""
|
||||
...
|
||||
def __str__(self) -> str:
|
||||
r"""
|
||||
@brief Gets the symbolic string from an enum
|
||||
"""
|
||||
...
|
||||
def _const_cast(self) -> VariantType:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def _create(self) -> None:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def _destroy(self) -> None:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def _destroyed(self) -> bool:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def _is_const_object(self) -> bool:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def _manage(self) -> None:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def _to_const_object(self) -> VariantType:
|
||||
r"""
|
||||
@hide
|
||||
"""
|
||||
...
|
||||
def _unmanage(self) -> None:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def assign(self, other: VariantType) -> None:
|
||||
r"""
|
||||
@brief Assigns another object to self
|
||||
"""
|
||||
...
|
||||
def create(self) -> None:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def destroy(self) -> None:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def destroyed(self) -> bool:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def dup(self) -> VariantType:
|
||||
r"""
|
||||
@brief Creates a copy of self
|
||||
"""
|
||||
...
|
||||
def hash(self) -> int:
|
||||
r"""
|
||||
@brief Gets the hash value from the enum
|
||||
"""
|
||||
...
|
||||
def inspect(self) -> str:
|
||||
r"""
|
||||
@brief Converts an enum to a visual string
|
||||
"""
|
||||
...
|
||||
def is_const_object(self) -> bool:
|
||||
r"""
|
||||
@brief 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.
|
||||
"""
|
||||
...
|
||||
def to_i(self) -> int:
|
||||
r"""
|
||||
@brief Gets the integer value from the enum
|
||||
"""
|
||||
...
|
||||
def to_s(self) -> str:
|
||||
r"""
|
||||
@brief Gets the symbolic string from an enum
|
||||
"""
|
||||
...
|
||||
...
|
||||
|
||||
class Vector:
|
||||
r"""
|
||||
@brief A integer vector class
|
||||
|
|
|
|||
|
|
@ -1270,17 +1270,17 @@ class RdbReference:
|
|||
@overload
|
||||
def database(self) -> ReportDatabase:
|
||||
r"""
|
||||
@brief Gets the database object that category is associated with (non-const version)
|
||||
@brief Gets the database object that category is associated with
|
||||
|
||||
This method has been introduced in version 0.29.
|
||||
This method has been introduced in version 0.23.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def database(self) -> ReportDatabase:
|
||||
r"""
|
||||
@brief Gets the database object that category is associated with
|
||||
@brief Gets the database object that category is associated with (non-const version)
|
||||
|
||||
This method has been introduced in version 0.23.
|
||||
This method has been introduced in version 0.29.
|
||||
"""
|
||||
...
|
||||
def destroy(self) -> None:
|
||||
|
|
|
|||
Loading…
Reference in New Issue