diff --git a/src/pymod/distutils_src/klayout/dbcore.pyi b/src/pymod/distutils_src/klayout/dbcore.pyi index 9bca6b8fb..8dd219692 100644 --- a/src/pymod/distutils_src/klayout/dbcore.pyi +++ b/src/pymod/distutils_src/klayout/dbcore.pyi @@ -402,6 +402,14 @@ class Box: This feature has been introduced in version 0.29. """ ... + def _const_cast(self) -> Box: + 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 @@ -437,6 +445,11 @@ class Box: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Box: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -878,6 +891,14 @@ class Cell: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Cell: + 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 @@ -913,6 +934,11 @@ class Cell: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Cell: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2242,10 +2268,19 @@ class Cell: This method has been introduced in version 0.24. """ ... + def properties(self) -> Any: + r""" + @brief Gets the user properties as a hash + This method is a convenience method that gets all user properties as a single hash. + + This method has been introduced in version 0.29.5. + """ + ... def property(self, key: Any) -> Any: r""" @brief Gets the user property with the given key - This method is a convenience method that gets the property with the given key. If no property with that key exists, it will return nil. Using that method is more convenient than using the layout object and the properties ID to retrieve the property value. + This method is a convenience method that gets the property with the given key. If no property with that key exists, it will return nil. Using that method is more convenient than using the layout object and the properties ID to retrieve the property value. + This method has been introduced in version 0.23. """ ... @@ -3106,6 +3141,14 @@ class CellInstArray: This method was introduced in version 0.22. """ ... + def _const_cast(self) -> CellInstArray: + 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 @@ -3141,6 +3184,11 @@ class CellInstArray: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> CellInstArray: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -3413,6 +3461,14 @@ class CellMapping: @brief Creates a new object of this class """ ... + def _const_cast(self) -> CellMapping: + 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 @@ -3448,6 +3504,11 @@ class CellMapping: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> CellMapping: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -3831,6 +3892,14 @@ class Circuit(NetlistObject): @brief Assigns another object to self """ ... + def _const_cast(self) -> Circuit: + 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 @@ -3871,6 +3940,11 @@ class Circuit(NetlistObject): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Circuit: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -5428,6 +5502,14 @@ class CompoundRegionOperationNode: @brief Creates a new object of this class """ ... + def _const_cast(self) -> CompoundRegionOperationNode: + 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 @@ -5463,6 +5545,11 @@ class CompoundRegionOperationNode: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> CompoundRegionOperationNode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -5552,6 +5639,14 @@ class Connectivity: @hide """ ... + def _const_cast(self) -> Connectivity: + 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 @@ -5587,6 +5682,11 @@ class Connectivity: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Connectivity: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -6366,6 +6466,14 @@ class CplxTrans: The lazy and DBU arguments have been added in version 0.27.6. """ ... + def _const_cast(self) -> CplxTrans: + 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 @@ -6401,6 +6509,11 @@ class CplxTrans: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> CplxTrans: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -7084,6 +7197,14 @@ class DBox: This feature has been introduced in version 0.29. """ ... + def _const_cast(self) -> DBox: + 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 @@ -7119,6 +7240,11 @@ class DBox: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DBox: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -7893,6 +8019,14 @@ class DCellInstArray: @brief Converts the array to a string """ ... + def _const_cast(self) -> DCellInstArray: + 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 @@ -7928,6 +8062,11 @@ class DCellInstArray: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DCellInstArray: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -8747,6 +8886,14 @@ class DCplxTrans: The lazy and DBU arguments have been added in version 0.27.6. """ ... + def _const_cast(self) -> DCplxTrans: + 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 @@ -8782,6 +8929,11 @@ class DCplxTrans: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DCplxTrans: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -9311,6 +9463,14 @@ class DEdge: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> DEdge: + 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 @@ -9346,6 +9506,11 @@ class DEdge: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DEdge: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -10054,6 +10219,14 @@ class DEdgePair: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> DEdgePair: + 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 @@ -10089,6 +10262,11 @@ class DEdgePair: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DEdgePair: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -10543,6 +10721,14 @@ class DPath: @brief Convert to a string """ ... + def _const_cast(self) -> DPath: + 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 @@ -10578,6 +10764,11 @@ class DPath: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DPath: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -11061,6 +11252,14 @@ class DPoint: Returns the scaled object. All coordinates are divided with the given divisor and if necessary rounded. """ ... + def _const_cast(self) -> DPoint: + 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 @@ -11096,6 +11295,11 @@ class DPoint: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DPoint: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -11434,6 +11638,14 @@ class DPolygon: @brief Returns a string representing the polygon """ ... + def _const_cast(self) -> DPolygon: + 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 @@ -11469,6 +11681,11 @@ class DPolygon: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DPolygon: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -12278,6 +12495,14 @@ class DSimplePolygon: @brief Returns a string representing the polygon """ ... + def _const_cast(self) -> DSimplePolygon: + 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 @@ -12313,6 +12538,11 @@ class DSimplePolygon: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DSimplePolygon: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -12784,8 +13014,7 @@ class DText: Setter: @brief Sets the horizontal 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. """ size: float r""" @@ -13008,6 +13237,14 @@ class DText: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> DText: + 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 @@ -13043,6 +13280,11 @@ class DText: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DText: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -13810,6 +14052,14 @@ class DTrans: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> DTrans: + 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 @@ -13845,6 +14095,11 @@ class DTrans: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DTrans: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -14289,6 +14544,14 @@ class DVector: Returns the scaled object. All coordinates are divided with the given divisor and if necessary rounded. """ ... + def _const_cast(self) -> DVector: + 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 @@ -14324,6 +14587,11 @@ class DVector: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DVector: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -14591,6 +14859,14 @@ class DeepShapeStore: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeepShapeStore: + 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 @@ -14626,6 +14902,11 @@ class DeepShapeStore: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeepShapeStore: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -14814,6 +15095,14 @@ class Device(NetlistObject): @brief Assigns another object to self """ ... + def _const_cast(self) -> Device: + 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 @@ -14854,6 +15143,11 @@ class Device(NetlistObject): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Device: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15065,6 +15359,14 @@ class DeviceAbstract: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeviceAbstract: + 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 @@ -15100,6 +15402,11 @@ class DeviceAbstract: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceAbstract: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15224,6 +15531,14 @@ class DeviceAbstractRef: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeviceAbstractRef: + 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 @@ -15259,6 +15574,11 @@ class DeviceAbstractRef: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceAbstractRef: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15417,6 +15737,14 @@ class DeviceClass: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeviceClass: + 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 @@ -15452,6 +15780,11 @@ class DeviceClass: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClass: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15692,6 +16025,14 @@ class DeviceClassBJT3Transistor(DeviceClass): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassBJT3Transistor: + 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 @@ -15732,6 +16073,11 @@ class DeviceClassBJT3Transistor(DeviceClass): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassBJT3Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15760,6 +16106,14 @@ class DeviceClassBJT4Transistor(DeviceClassBJT3Transistor): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassBJT4Transistor: + 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 @@ -15800,6 +16154,11 @@ class DeviceClassBJT4Transistor(DeviceClassBJT3Transistor): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassBJT4Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15845,6 +16204,14 @@ class DeviceClassCapacitor(DeviceClass): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassCapacitor: + 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 @@ -15885,6 +16252,11 @@ class DeviceClassCapacitor(DeviceClass): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassCapacitor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15913,6 +16285,14 @@ class DeviceClassCapacitorWithBulk(DeviceClassCapacitor): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassCapacitorWithBulk: + 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 @@ -15953,6 +16333,11 @@ class DeviceClassCapacitorWithBulk(DeviceClassCapacitor): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassCapacitorWithBulk: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -15994,6 +16379,14 @@ class DeviceClassDiode(DeviceClass): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassDiode: + 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 @@ -16034,6 +16427,11 @@ class DeviceClassDiode(DeviceClass): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassDiode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16090,6 +16488,14 @@ class DeviceClassFactory: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeviceClassFactory: + 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 @@ -16125,6 +16531,11 @@ class DeviceClassFactory: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassFactory: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16198,6 +16609,14 @@ class DeviceClassInductor(DeviceClass): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassInductor: + 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 @@ -16238,6 +16657,11 @@ class DeviceClassInductor(DeviceClass): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassInductor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16302,6 +16726,14 @@ class DeviceClassMOS3Transistor(DeviceClass): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassMOS3Transistor: + 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 @@ -16342,6 +16774,11 @@ class DeviceClassMOS3Transistor(DeviceClass): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassMOS3Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16377,6 +16814,14 @@ class DeviceClassMOS4Transistor(DeviceClassMOS3Transistor): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassMOS4Transistor: + 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 @@ -16417,6 +16862,11 @@ class DeviceClassMOS4Transistor(DeviceClassMOS3Transistor): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassMOS4Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16470,6 +16920,14 @@ class DeviceClassResistor(DeviceClass): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassResistor: + 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 @@ -16510,6 +16968,11 @@ class DeviceClassResistor(DeviceClass): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassResistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16538,6 +17001,14 @@ class DeviceClassResistorWithBulk(DeviceClassResistor): @brief Assigns another object to self """ ... + def _const_cast(self) -> DeviceClassResistorWithBulk: + 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 @@ -16578,6 +17049,11 @@ class DeviceClassResistorWithBulk(DeviceClassResistor): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceClassResistorWithBulk: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16638,6 +17114,14 @@ class DeviceExtractorBJT3Transistor(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorBJT3Transistor: + 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 @@ -16673,6 +17157,11 @@ class DeviceExtractorBJT3Transistor(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorBJT3Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16717,6 +17206,14 @@ class DeviceExtractorBJT4Transistor(DeviceExtractorBJT3Transistor): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorBJT4Transistor: + 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 @@ -16752,6 +17249,11 @@ class DeviceExtractorBJT4Transistor(DeviceExtractorBJT3Transistor): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorBJT4Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16789,6 +17291,14 @@ class DeviceExtractorBase: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeviceExtractorBase: + 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 @@ -16824,6 +17334,11 @@ class DeviceExtractorBase: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorBase: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -16936,6 +17451,14 @@ class DeviceExtractorCapacitor(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorCapacitor: + 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 @@ -16971,6 +17494,11 @@ class DeviceExtractorCapacitor(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorCapacitor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17029,6 +17557,14 @@ class DeviceExtractorCapacitorWithBulk(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorCapacitorWithBulk: + 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 @@ -17064,6 +17600,11 @@ class DeviceExtractorCapacitorWithBulk(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorCapacitorWithBulk: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17124,6 +17665,14 @@ class DeviceExtractorDiode(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorDiode: + 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 @@ -17159,6 +17708,11 @@ class DeviceExtractorDiode(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorDiode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17229,6 +17783,14 @@ class DeviceExtractorMOS3Transistor(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorMOS3Transistor: + 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 @@ -17264,6 +17826,11 @@ class DeviceExtractorMOS3Transistor(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorMOS3Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17319,6 +17886,14 @@ class DeviceExtractorMOS4Transistor(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorMOS4Transistor: + 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 @@ -17354,6 +17929,11 @@ class DeviceExtractorMOS4Transistor(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorMOS4Transistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17413,6 +17993,14 @@ class DeviceExtractorResistor(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorResistor: + 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 @@ -17448,6 +18036,11 @@ class DeviceExtractorResistor(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorResistor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17507,6 +18100,14 @@ class DeviceExtractorResistorWithBulk(DeviceExtractorBase): For the 'factory' parameter see \DeviceClassFactory. It has been added in version 0.27.3. """ ... + def _const_cast(self) -> DeviceExtractorResistorWithBulk: + 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 @@ -17542,6 +18143,11 @@ class DeviceExtractorResistorWithBulk(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceExtractorResistorWithBulk: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17647,6 +18253,14 @@ class DeviceParameterDefinition: @param geo_scaling_exponent Indicates how the parameter scales with geometrical scaling (0: no scaling, 1.0: linear, 2.0: quadratic) """ ... + def _const_cast(self) -> DeviceParameterDefinition: + 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 @@ -17682,6 +18296,11 @@ class DeviceParameterDefinition: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceParameterDefinition: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17783,6 +18402,14 @@ class DeviceReconnectedTerminal: @brief Creates a new object of this class """ ... + def _const_cast(self) -> DeviceReconnectedTerminal: + 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 @@ -17818,6 +18445,11 @@ class DeviceReconnectedTerminal: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceReconnectedTerminal: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -17907,6 +18539,14 @@ class DeviceTerminalDefinition: @brief Creates a new terminal definition. """ ... + def _const_cast(self) -> DeviceTerminalDefinition: + 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 @@ -17942,6 +18582,11 @@ class DeviceTerminalDefinition: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> DeviceTerminalDefinition: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -18234,6 +18879,14 @@ class Edge: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> Edge: + 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 @@ -18269,6 +18922,11 @@ class Edge: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Edge: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -18900,6 +19558,14 @@ class EdgeFilter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgeFilter: + 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 @@ -18935,6 +19601,11 @@ class EdgeFilter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgeFilter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -19138,6 +19809,14 @@ class EdgeMode: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> EdgeMode: + 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 @@ -19173,6 +19852,11 @@ class EdgeMode: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgeMode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -19345,6 +20029,14 @@ class EdgeOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgeOperator: + 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 @@ -19380,6 +20072,11 @@ class EdgeOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgeOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -19600,6 +20297,14 @@ class EdgePair: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> EdgePair: + 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 @@ -19635,6 +20340,11 @@ class EdgePair: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgePair: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -19883,6 +20593,14 @@ class EdgePairFilter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgePairFilter: + 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 @@ -19918,6 +20636,11 @@ class EdgePairFilter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgePairFilter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -20042,6 +20765,14 @@ class EdgePairOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgePairOperator: + 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 @@ -20077,6 +20808,11 @@ class EdgePairOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgePairOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -20183,6 +20919,14 @@ class EdgePairToEdgeOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgePairToEdgeOperator: + 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 @@ -20218,6 +20962,11 @@ class EdgePairToEdgeOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgePairToEdgeOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -20324,6 +21073,14 @@ class EdgePairToPolygonOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgePairToPolygonOperator: + 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 @@ -20359,6 +21116,11 @@ class EdgePairToPolygonOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgePairToPolygonOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -20754,6 +21516,14 @@ class EdgePairs(ShapeCollection): The length of the output is limited to 20 edge pairs to avoid giant strings on large regions. For full output use "to_s" with a maximum count parameter. """ ... + def _const_cast(self) -> EdgePairs: + 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 @@ -20789,6 +21559,11 @@ class EdgePairs(ShapeCollection): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgePairs: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -21006,6 +21781,45 @@ class EdgePairs(ShapeCollection): This method has been introduced in version 0.26. """ ... + def inside(self, other: Region) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which are inside (completely covered by) polygons from the region + + @return A new edge pair collection containing the edge pairs completely inside polygons from the region + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def interacting(self, other: Edges, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which overlap or touch edges from the other edge collection + + @return A new edge pair collection containing the edge pairs overlapping or touching edges from the other edge collection + + 'min_count' and 'max_count' impose a constraint on the number of times an edge pair of this collection has to interact with (different) edges of the other collection to make the edge pair selected. An edge pair is not selected by this method if the number of edges interacting with an edge pair of this collection is between min_count and max_count (including max_count). + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def interacting(self, other: Region, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which overlap or touch polygons from the region + + @return A new edge pair collection containing the edge pairs overlapping or touching polygons from the region + + 'min_count' and 'max_count' impose a constraint on the number of times an edge pair of this collection has to interact with (different) polygons of the other region to make the edge pair selected. An edge pair is not selected by this method if the number of polygons interacting with an edge pair of this collection is between min_count and max_count (including max_count). + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... def is_const_object(self) -> bool: r""" @brief Returns a value indicating whether the reference is a const reference @@ -21119,6 +21933,67 @@ class EdgePairs(ShapeCollection): @return The moved edge pairs. """ ... + def not_inside(self, other: Region) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which are not inside (not completely covered by) polygons from the region + + @return A new edge pair collection containing the edge pairs not completely inside polygons from the region + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def not_interacting(self, other: Edges, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which do not overlap or touch edges from the other edge collection + + @return A new edge pair collection containing the edge pairs not overlapping or touching edges from the other edge collection + + 'min_count' and 'max_count' impose a constraint on the number of times an edge pair of this collection has to interact with (different) edges of the other collection to make the edge pair selected. An edge pair is not selected by this method if the number of edges interacting with an edge pair of this collection is between min_count and max_count (including max_count). + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def not_interacting(self, other: Region, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which do not overlap or touch polygons from the region + + @return A new edge pair collection containing the edge pairs not overlapping or touching polygons from the region + + 'min_count' and 'max_count' impose a constraint on the number of times an edge pair of this collection has to interact with (different) polygons of the other region to make the edge pair selected. An edge pair is not selected by this method if the number of polygons interacting with an edge pair of this collection is between min_count and max_count (including max_count). + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + def not_outside(self, other: Region) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which are not outside (partially overlapped by) polygons from the other region + + @return A new edge pair collection containing the the selected edges + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + def outside(self, other: Region) -> EdgePairs: + r""" + @brief Returns the edge pairs from this edge pair collection which are outside (not overlapped by) polygons from the other region + + @return A new edge pair collection containing the the selected edges + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... @overload def polygons(self) -> Region: r""" @@ -21168,6 +22043,36 @@ class EdgePairs(ShapeCollection): This method has been introduced in version 0.29. """ ... + @overload + def pull_interacting(self, other: Edges) -> Edges: + r""" + @brief Returns all edges of "other" which are interacting with (overlapping, touching) edge pairs of this set + The "pull_..." methods are similar to "select_..." but work the opposite way: they select shapes from the argument region rather than self. In a deep (hierarchical) context the output region will be hierarchically aligned with self, so the "pull_..." methods provide a way for re-hierarchization. + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + @return The edge collection after the edges have been selected (from other) + + Merged semantics applies for this method (see \merged_semantics= of merged semantics) + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def pull_interacting(self, other: Region) -> Region: + r""" + @brief Returns all polygons of "other" which are interacting with (overlapping, touching) edge pairs of this set + The "pull_..." methods are similar to "select_..." but work the opposite way: they select shapes from the argument region rather than self. In a deep (hierarchical) context the output region will be hierarchically aligned with self, so the "pull_..." methods provide a way for re-hierarchization. + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + @return The region after the polygons have been selected (from other) + + Merged semantics applies for this method (see \merged_semantics= of merged semantics) + + This method has been introduced in version 0.29.6 + """ + ... def remove_properties(self) -> None: r""" @brief Removes properties for the given container. @@ -21182,6 +22087,98 @@ class EdgePairs(ShapeCollection): @return An edge collection containing the second edges """ ... + def select_inside(self, other: Region) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which are inside (completely covered by) polygons from the region + + @return The edge pair collection after the edge pairs have been selected (self) + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def select_interacting(self, other: Edges, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which overlap or touch edges from the other edge collection + + @return The edge pair collection after the edge pairs have been selected (self) + + This is the in-place version of \interacting - i.e. self is modified rather than a new collection is returned. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def select_interacting(self, other: Region, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which overlap or touch polygons from the region + + @return The edge pair collection after the edge pairs have been selected (self) + + This is the in-place version of \interacting - i.e. self is modified rather than a new collection is returned. + + This method has been introduced in version 0.29.6 + """ + ... + def select_not_inside(self, other: Region) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which are not inside (completely covered by) polygons from the region + + @return The edge pair collection after the edge pairs have been selected (self) + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def select_not_interacting(self, other: Edges, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which do not overlap or touch edges from the other edge collection + + @return The edge pair collection after the edge pairs have been selected (self) + + This is the in-place version of \not_interacting - i.e. self is modified rather than a new collection is returned. + + This method has been introduced in version 0.29.6 + """ + ... + @overload + def select_not_interacting(self, other: Region, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which do not overlap or touch polygons from the region + + @return The edge pair collection after the edge pairs have been selected (self) + + This is the in-place version of \not_interacting - i.e. self is modified rather than a new collection is returned. + + This method has been introduced in version 0.29.6 + """ + ... + def select_not_outside(self, other: Region) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which are not outside (partially overlapped by) polygons from the other region + + @return The edge pair collection after the edges have been selected (self) + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... + def select_outside(self, other: Region) -> EdgePairs: + r""" + @brief Selects the edge pairs from this edge pair collection which are outside (not overlapped by) polygons from the other region + + @return The edge pair collection after the edges have been selected (self) + + Edge pairs are considered 'filled' in the context of this operation - i.e. the area between the edges belongs to the edge pair, hence participates in the check. + + This method has been introduced in version 0.29.6 + """ + ... def size(self) -> int: r""" @brief Returns the (flat) number of edge pairs in the edge pair collection @@ -21191,6 +22188,45 @@ class EdgePairs(ShapeCollection): Starting with version 0.27, the method is called 'count' for consistency with \Region. 'size' is still provided as an alias. """ ... + def split_inside(self, other: Region) -> List[EdgePairs]: + r""" + @brief Selects the edge pairs from this edge pair collection which are and are not inside (completely covered by) polygons from the other region + + @return A two-element list of edge pair collections (first: inside, second: non-inside) + + This method provides a faster way to compute both inside and non-inside edge pairs compared to using separate methods. It has been introduced in version 0.29.6. + """ + ... + @overload + def split_interacting(self, other: Edges, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> List[EdgePairs]: + r""" + @brief Selects the edge pairs from this edge pair collection which do and do not interact with edges from the other collection + + @return A two-element list of edge pair collections (first: interacting, second: non-interacting) + + This method provides a faster way to compute both interacting and non-interacting edges compared to using separate methods. It has been introduced in version 0.29.6. + """ + ... + @overload + def split_interacting(self, other: Region, min_count: Optional[int] = ..., max_count: Optional[int] = ...) -> List[EdgePairs]: + r""" + @brief Selects the edge pairs from this edge pair collection which do and do not interact with polygons from the other region + + @return A two-element list of edge pair collections (first: interacting, second: non-interacting) + + This method provides a faster way to compute both interacting and non-interacting edges compared to using separate methods. It has been introduced in version 0.29.6. + """ + ... + def split_outside(self, other: Region) -> List[EdgePairs]: + r""" + @brief Selects the edge pairs from this edge pair collection which are and are not outside (not overlapped by) polygons from the other region + + @return A two-element list of edge pair collections (first: outside, second: non-outside) + + This method provides a faster way to compute both outside and non-outside edges compared to using separate methods. + This method has been introduced in version 0.29.6 + """ + ... def swap(self, other: EdgePairs) -> None: r""" @brief Swap the contents of this collection with the contents of another collection @@ -21712,6 +22748,14 @@ class EdgeProcessor: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgeProcessor: + 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 @@ -21747,6 +22791,11 @@ class EdgeProcessor: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgeProcessor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -22675,6 +23724,14 @@ class EdgeToEdgePairOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgeToEdgePairOperator: + 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 @@ -22710,6 +23767,11 @@ class EdgeToEdgePairOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgeToEdgePairOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -22856,6 +23918,14 @@ class EdgeToPolygonOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EdgeToPolygonOperator: + 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 @@ -22891,6 +23961,11 @@ class EdgeToPolygonOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EdgeToPolygonOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -23861,6 +24936,14 @@ class Edges(ShapeCollection): The 'xor' alias has been introduced in version 0.28.12. """ ... + def _const_cast(self) -> Edges: + 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 @@ -23896,6 +24979,11 @@ class Edges(ShapeCollection): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Edges: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -24423,7 +25511,7 @@ class Edges(ShapeCollection): r""" @brief Returns the edges of this edge collection which are inside (completely covered by) edges from the other edge collection - @return A new edge collection containing the edges overlapping or touching edges from the other edge collection + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24433,7 +25521,7 @@ class Edges(ShapeCollection): r""" @brief Returns the edges from this edge collection which are inside (completely covered by) polygons from the region - @return A new edge collection containing the edges overlapping or touching polygons from the region + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24721,7 +25809,7 @@ class Edges(ShapeCollection): r""" @brief Returns the edges of this edge collection which are not inside (completely covered by) edges from the other edge collection - @return A new edge collection containing the edges not overlapping or touching edges from the other edge collection + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24731,7 +25819,7 @@ class Edges(ShapeCollection): r""" @brief Returns the edges from this edge collection which are not inside (completely covered by) polygons from the region - @return A new edge collection containing the edges not overlapping or touching polygons from the region + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24769,9 +25857,9 @@ class Edges(ShapeCollection): @overload def not_outside(self, other: Edges) -> Edges: r""" - @brief Returns the edges of this edge collection which are not outside (completely covered by) edges from the other edge collection + @brief Returns the edges of this edge collection which are not outside (partially overlapped by) edges from the other edge collection - @return A new edge collection containing the edges not overlapping or touching edges from the other edge collection + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24779,9 +25867,9 @@ class Edges(ShapeCollection): @overload def not_outside(self, other: Region) -> Edges: r""" - @brief Returns the edges from this edge collection which are not outside (completely covered by) polygons from the region + @brief Returns the edges from this edge collection which are not outside (partially overlapped by) polygons from the region - @return A new edge collection containing the edges not overlapping or touching polygons from the region + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24842,9 +25930,9 @@ class Edges(ShapeCollection): @overload def outside(self, other: Edges) -> Edges: r""" - @brief Returns the edges of this edge collection which are outside (completely covered by) edges from the other edge collection + @brief Returns the edges of this edge collection which are outside (not overlapped by) edges from the other edge collection - @return A new edge collection containing the edges overlapping or touching edges from the other edge collection + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -24852,9 +25940,9 @@ class Edges(ShapeCollection): @overload def outside(self, other: Region) -> Edges: r""" - @brief Returns the edges from this edge collection which are outside (completely covered by) polygons from the region + @brief Returns the edges from this edge collection which are outside (not overlapped by) polygons from the region - @return A new edge collection containing the edges overlapping or touching polygons from the region + @return A new edge collection containing the the selected edges This method has been introduced in version 0.28. """ @@ -25072,7 +26160,7 @@ class Edges(ShapeCollection): @overload def select_not_outside(self, other: Edges) -> Edges: r""" - @brief Selects the edges from this edge collection which are not outside (completely covered by) edges from the other edge collection + @brief Selects the edges from this edge collection which are not outside (partially overlapped by) edges from the other edge collection @return The edge collection after the edges have been selected (self) @@ -25082,7 +26170,7 @@ class Edges(ShapeCollection): @overload def select_not_outside(self, other: Region) -> Edges: r""" - @brief Selects the edges from this edge collection which are not outside (completely covered by) polygons from the region + @brief Selects the edges from this edge collection which are not outside (partially overlapped by) polygons from the region @return The edge collection after the edges have been selected (self) @@ -25092,7 +26180,7 @@ class Edges(ShapeCollection): @overload def select_outside(self, other: Edges) -> Edges: r""" - @brief Selects the edges from this edge collection which are outside (completely covered by) edges from the other edge collection + @brief Selects the edges from this edge collection which are outside (not overlapped by) edges from the other edge collection @return The edge collection after the edges have been selected (self) @@ -25102,7 +26190,7 @@ class Edges(ShapeCollection): @overload def select_outside(self, other: Region) -> Edges: r""" - @brief Selects the edges from this edge collection which are outside (completely covered by) polygons from the region + @brief Selects the edges from this edge collection which are outside (not overlapped by) polygons from the region @return The edge collection after the edges have been selected (self) @@ -25227,7 +26315,7 @@ class Edges(ShapeCollection): @overload def split_outside(self, other: Edges) -> List[Edges]: r""" - @brief Selects the edges from this edge collection which are and are not outside (completely covered by) edges from the other collection + @brief Selects the edges from this edge collection which are and are not outside (not overlapped by) edges from the other collection @return A two-element list of edge collections (first: outside, second: non-outside) @@ -25237,7 +26325,7 @@ class Edges(ShapeCollection): @overload def split_outside(self, other: Region) -> List[Edges]: r""" - @brief Selects the edges from this edge collection which are and are not outside (completely covered by) polygons from the other region + @brief Selects the edges from this edge collection which are and are not outside (not overlapped by) polygons from the other region @return A two-element list of edge collections (first: outside, second: non-outside) @@ -25619,6 +26707,14 @@ class EqualDeviceParameters: If 'absolute' and 'relative' are both given, their deviations will add to the allowed difference between two parameter values. The relative deviation will be applied to the mean value of both parameter values. For example, when comparing parameter values of 40 and 60, a relative deviation of 0.35 means an absolute deviation of 17.5 (= 0.35 * average of 40 and 60) which does not make both values match. """ ... + def _const_cast(self) -> EqualDeviceParameters: + 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 @@ -25654,6 +26750,11 @@ class EqualDeviceParameters: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EqualDeviceParameters: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -25737,6 +26838,14 @@ class GenericDeviceCombiner: @brief Creates a new object of this class """ ... + def _const_cast(self) -> GenericDeviceCombiner: + 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 @@ -25772,6 +26881,11 @@ class GenericDeviceCombiner: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> GenericDeviceCombiner: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -25845,6 +26959,14 @@ class GenericDeviceExtractor(DeviceExtractorBase): This class has been introduced in version 0.26. """ + def _const_cast(self) -> GenericDeviceExtractor: + 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 @@ -25880,6 +27002,11 @@ class GenericDeviceExtractor(DeviceExtractorBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> GenericDeviceExtractor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -26092,6 +27219,14 @@ class GenericDeviceParameterCompare(EqualDeviceParameters): @brief Assigns another object to self """ ... + def _const_cast(self) -> GenericDeviceParameterCompare: + 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 @@ -26132,6 +27267,11 @@ class GenericDeviceParameterCompare(EqualDeviceParameters): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> GenericDeviceParameterCompare: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -26164,6 +27304,14 @@ class GenericNetlistCompareLogger(NetlistCompareLogger): r""" @brief Specifies warning severity (log with high priority, but do not stop) """ + def _const_cast(self) -> GenericNetlistCompareLogger: + 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 @@ -26199,6 +27347,11 @@ class GenericNetlistCompareLogger(NetlistCompareLogger): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> GenericNetlistCompareLogger: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -26322,6 +27475,14 @@ class HAlign: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> HAlign: + 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 @@ -26357,6 +27518,11 @@ class HAlign: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> HAlign: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -27109,6 +28275,14 @@ class ICplxTrans: The lazy and DBU arguments have been added in version 0.27.6. """ ... + def _const_cast(self) -> ICplxTrans: + 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 @@ -27144,6 +28318,11 @@ class ICplxTrans: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ICplxTrans: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -27686,6 +28865,14 @@ class IMatrix2d: @return The string representing this matrix """ ... + def _const_cast(self) -> IMatrix2d: + 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 @@ -27721,6 +28908,11 @@ class IMatrix2d: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> IMatrix2d: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -28162,6 +29354,14 @@ class IMatrix3d: @return The string representing this matrix """ ... + def _const_cast(self) -> IMatrix3d: + 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 @@ -28197,6 +29397,11 @@ class IMatrix3d: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> IMatrix3d: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -28424,6 +29629,14 @@ class InstElement: See the comments on the == operator. """ ... + def _const_cast(self) -> InstElement: + 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 @@ -28459,6 +29672,11 @@ class InstElement: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> InstElement: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -28590,11 +29808,11 @@ class Instance: Starting with version 0.25 the displacement is of vector type. Setter: - @brief Sets the displacement vector for the 'a' axis + @brief Sets the displacement vector for the 'a' axis in micrometer units - If the instance was not an array instance before it is made one. + Like \a= 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. """ b: Vector r""" @@ -28859,6 +30077,14 @@ class Instance: This method has been introduced with version 0.16. """ ... + def _const_cast(self) -> Instance: + 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 @@ -28894,6 +30120,11 @@ class Instance: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Instance: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -29173,6 +30404,14 @@ class Instance: This method has been introduced in version 0.24. """ ... + def properties(self) -> Any: + r""" + @brief Gets the user properties as a hash + This method is a convenience method that gets all user properties as a single hash. + + This method has been introduced in version 0.29.5. + """ + ... def property(self, key: Any) -> Any: r""" @brief Gets the user property with the given key @@ -30011,6 +31250,14 @@ class LEFDEFReaderConfiguration: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LEFDEFReaderConfiguration: + 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 @@ -30046,6 +31293,11 @@ class LEFDEFReaderConfiguration: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LEFDEFReaderConfiguration: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -30543,6 +31795,14 @@ class LayerInfo: The 'as_target' argument has been added in version 0.26.5. """ ... + def _const_cast(self) -> LayerInfo: + 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 @@ -30578,6 +31838,11 @@ class LayerInfo: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerInfo: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -30767,6 +32032,14 @@ class LayerMap: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LayerMap: + 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 @@ -30802,6 +32075,11 @@ class LayerMap: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerMap: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -31113,6 +32391,14 @@ class LayerMapping: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LayerMapping: + 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 @@ -31148,6 +32434,11 @@ class LayerMapping: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerMapping: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -31412,6 +32703,14 @@ class Layout: Starting with version 0.25, layouts created with the default constructor are always editable. Before that version, they inherited the editable flag from the application. """ ... + def _const_cast(self) -> Layout: + 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 @@ -31447,6 +32746,11 @@ class Layout: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Layout: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -31739,6 +33043,32 @@ class Layout: """ ... @overload + def break_polygons(self, layer: int, max_vertex_count: int, max_area_ratio: float) -> None: + r""" + @brief Breaks the polygons of the layer into smaller ones + + This variant applies breaking to all cells and the given layer. + + This method has been introduced in version 0.29.5. + """ + ... + @overload + def break_polygons(self, max_vertex_count: int, max_area_ratio: float) -> None: + r""" + @brief Breaks the polygons of the layout into smaller ones + + There are two criteria for splitting a polygon: a polygon is split into parts with less then 'max_vertex_count' points and an bounding box-to-polygon area ratio less than 'max_area_ratio'. The area ratio is supposed to render polygons whose bounding box is a better approximation. This applies for example to 'L' shape polygons. + + Using a value of 0 for either limit means that the respective limit isn't checked. Breaking happens by cutting the polygons into parts at 'good' locations. The algorithm does not have a specific goal to minimize the number of parts for example. The only goal is to achieve parts within the given limits. + + Breaking also applies to paths if their polygon representation satisfies the breaking criterion. In that case, paths are converted to polygons and broken into smaller parts. + + This variant applies breaking to all cells and layers. + + This method has been introduced in version 0.29.5. + """ + ... + @overload def cell(self, i: int) -> Cell: r""" @brief Gets a cell object from the cell index @@ -31750,6 +33080,19 @@ class Layout: """ ... @overload + def cell(self, i: int) -> Cell: + r""" + @brief Gets a cell object from the cell index (const version) + + @param i The cell index + @return A reference to the cell (a \Cell object) + + If the cell index is not a valid cell index, this method will raise an error. Use \is_valid_cell_index? to test whether a given cell index is valid. + + This variant has been introduced in version 0.29.6. + """ + ... + @overload def cell(self, name: str) -> Cell: r""" @brief Gets a cell object from the cell name @@ -31761,6 +33104,20 @@ class Layout: This method has been introduced in version 0.23 and replaces \cell_by_name. """ ... + @overload + def cell(self, name: str) -> Cell: + r""" + @brief Gets a cell object from the cell name (const version) + + @param name The cell name + @return A reference to the cell (a \Cell object) + + If name is not a valid cell name, this method will return "nil". + This method has been introduced in version 0.23 and replaces \cell_by_name. + + This variant has been introduced in version 0.29.6. + """ + ... def cell_by_name(self, name: str) -> int: r""" @brief Gets the cell index for a given name @@ -31792,6 +33149,19 @@ class Layout: This method has been introduced in version 0.27.3. """ ... + @overload + def cells(self, name_filter: str) -> List[Cell]: + r""" + @brief Gets the cell objects for a given name filter (const version) + + @param name_filter The cell name filter (glob pattern) + @return A list of \Cell object of the cells matching the pattern + + This method has been introduced in version 0.27.3. + + This variant has been introduced in version 0.29.6. + """ + ... def cleanup(self, cell_indexes_to_keep: Optional[Sequence[int]] = ...) -> None: r""" @brief Cleans up the layout @@ -32807,6 +34177,16 @@ class Layout: This method has been introduced in version 0.24. """ ... + @overload + def properties(self) -> Any: + r""" + @brief Gets the user properties as a hash + This method is a convenience method that gets all user properties as a single hash. + + This method has been introduced in version 0.29.5. + """ + ... + @overload def properties(self, properties_id: int) -> List[Any]: r""" @brief Gets the properties set for a given properties ID @@ -32991,6 +34371,7 @@ class Layout: This method has been introduced in version 0.27. Before that, the technology has been kept in the 'technology' meta data element. """ ... + @overload def top_cell(self) -> Cell: r""" @brief Returns the top cell object @@ -33002,6 +34383,19 @@ class Layout: This method has been introduced in version 0.23. """ ... + @overload + def top_cell(self) -> Cell: + r""" + @brief Returns the top cell object (const version) + @return The \Cell object of the top cell + If the layout has a single top cell, this method returns the top cell's \Cell object. + If the layout does not have a top cell, this method returns "nil". If the layout has multiple + top cells, this method raises an error. + + This variant has been introduced in version 0.29.6. + """ + ... + @overload def top_cells(self) -> List[Cell]: r""" @brief Returns the top cell objects @@ -33013,6 +34407,17 @@ class Layout: """ ... @overload + def top_cells(self) -> List[Cell]: + r""" + @brief Returns the top cell objects (const version) + @return The \Cell objects of the top cells + This method returns and array of \Cell objects representing the top cells of the layout. + This array can be empty, if the layout does not have a top cell (i.e. no cell at all). + + This variant has been introduced in version 0.29.6. + """ + ... + @overload def transform(self, trans: DCplxTrans) -> None: r""" @brief Transforms the layout with the given complex integer transformation, which is in micrometer units @@ -33615,6 +35020,14 @@ class LayoutDiff: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LayoutDiff: + 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 @@ -33650,6 +35063,11 @@ class LayoutDiff: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutDiff: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -33883,6 +35301,14 @@ class LayoutMetaInfo: The 'persisted' attribute has been introduced in version 0.28.8. """ ... + def _const_cast(self) -> LayoutMetaInfo: + 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 @@ -33918,6 +35344,11 @@ class LayoutMetaInfo: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutMetaInfo: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -34002,6 +35433,14 @@ class LayoutQuery: @brief Creates a new query object from the given query string """ ... + def _const_cast(self) -> LayoutQuery: + 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 @@ -34037,6 +35476,11 @@ class LayoutQuery: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutQuery: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -34119,6 +35563,14 @@ class LayoutQueryIterator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LayoutQueryIterator: + 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 @@ -34154,6 +35606,11 @@ class LayoutQueryIterator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutQueryIterator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -34674,6 +36131,14 @@ class LayoutToNetlist: The database unit is mandatory because the physical parameter extraction for devices requires this unit for translation of layout to physical dimensions. """ ... + def _const_cast(self) -> LayoutToNetlist: + 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 @@ -34709,6 +36174,11 @@ class LayoutToNetlist: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutToNetlist: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -35596,6 +37066,14 @@ class LayoutVsSchematic(LayoutToNetlist): See the corresponding constructor of the \LayoutToNetlist object for more details. """ ... + def _const_cast(self) -> LayoutVsSchematic: + 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 @@ -35631,6 +37109,11 @@ class LayoutVsSchematic(LayoutToNetlist): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutVsSchematic: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -35770,6 +37253,14 @@ class Library: @brief Creates a new, empty library """ ... + def _const_cast(self) -> Library: + 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 @@ -35805,6 +37296,11 @@ class Library: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Library: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -36577,204 +38073,6 @@ class LoadLayoutOptions: This method has been added in version 0.26.2. """ - mebes_boundary_datatype: int - r""" - Getter: - @brief Gets the datatype number of the boundary layer to produce - See \mebes_produce_boundary= for a description of this attribute. - - This property has been added in version 0.23.10. - - Setter: - @brief Sets the datatype number of the boundary layer to produce - See \mebes_produce_boundary= for a description of this attribute. - - This property has been added in version 0.23.10. - """ - mebes_boundary_layer: int - r""" - Getter: - @brief Gets the layer number of the boundary layer to produce - See \mebes_produce_boundary= for a description of this attribute. - - This property has been added in version 0.23.10. - - Setter: - @brief Sets the layer number of the boundary layer to produce - See \mebes_produce_boundary= for a description of this attribute. - - This property has been added in version 0.23.10. - """ - mebes_boundary_name: str - r""" - Getter: - @brief Gets the name of the boundary layer to produce - See \mebes_produce_boundary= for a description of this attribute. - - This property has been added in version 0.23.10. - - Setter: - @brief Sets the name of the boundary layer to produce - See \mebes_produce_boundary= for a description of this attribute. - - This property has been added in version 0.23.10. - """ - mebes_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 \mebes_layer_map=). Layers not listed in this map are created as well when \mebes_create_other_layers? is true. Otherwise they are ignored. - - This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion. - Setter: - @brief Specifies whether other layers shall be created - @param create True, if other layers will be created. - See \mebes_create_other_layers? for a description of this attribute. - - This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion. - """ - mebes_data_datatype: int - r""" - Getter: - @brief Gets the datatype number of the data layer to produce - - This property has been added in version 0.23.10. - - Setter: - @brief Sets the datatype number of the data layer to produce - - This property has been added in version 0.23.10. - """ - mebes_data_layer: int - r""" - Getter: - @brief Gets the layer number of the data layer to produce - - This property has been added in version 0.23.10. - - Setter: - @brief Sets the layer number of the data layer to produce - - This property has been added in version 0.23.10. - """ - mebes_data_name: str - r""" - Getter: - @brief Gets the name of the data layer to produce - - This property has been added in version 0.23.10. - - Setter: - @brief Sets the name of the data layer to produce - - This property has been added in version 0.23.10. - """ - mebes_invert: bool - r""" - Getter: - @brief Gets a value indicating whether to invert the MEBES pattern - If this property is set to true, the pattern will be inverted. - - This property has been added in version 0.22. - - Setter: - @brief Specify whether to invert the MEBES pattern - If this property is set to true, the pattern will be inverted. - - This property has been added in version 0.22. - """ - mebes_layer_map: LayerMap - r""" - Getter: - @brief Gets the layer map - @return The layer map. - - This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion. - Setter: - @brief Sets the layer map - This sets a layer mapping for the reader. Unlike \mebes_set_layer_map, the 'create_other_layers' flag is not changed. - @param map The layer map to set. - - This convenience method has been added in version 0.26.2. - """ - mebes_num_shapes_per_cell: int - r""" - Getter: - @brief Gets the number of stripes collected per cell - See \mebes_num_stripes_per_cell= for details about this property. - - This property has been added in version 0.24.5. - - Setter: - @brief Specify the number of stripes collected per cell - See \mebes_num_stripes_per_cell= for details about this property. - - This property has been added in version 0.24.5. - """ - mebes_num_stripes_per_cell: int - r""" - Getter: - @brief Gets the number of stripes collected per cell - See \mebes_num_stripes_per_cell= for details about this property. - - This property has been added in version 0.23.10. - - Setter: - @brief Specify the number of stripes collected per cell - This property specifies how many stripes will be collected into one cell. - A smaller value means less but bigger cells. The default value is 64. - New cells will be formed whenever more than this number of stripes has been read - or a new segment is started and the number of shapes given by \mebes_num_shapes_per_cell - is exceeded. - - This property has been added in version 0.23.10. - """ - mebes_produce_boundary: bool - r""" - Getter: - @brief Gets a value indicating whether a boundary layer will be produced - See \mebes_produce_boundary= for details about this property. - - This property has been added in version 0.23.10. - - Setter: - @brief Specify whether to produce a boundary layer - If this property is set to true, the pattern boundary will be written to the layer and datatype specified with \mebes_boundary_name, \mebes_boundary_layer and \mebes_boundary_datatype. - By default, the boundary layer is produced. - - This property has been added in version 0.23.10. - """ - mebes_subresolution: bool - r""" - Getter: - @brief Gets a value indicating whether to invert the MEBES pattern - See \subresolution= for details about this property. - - This property has been added in version 0.23.10. - - Setter: - @brief Specify whether subresolution trapezoids are supported - If this property is set to true, subresolution trapezoid vertices are supported. - In order to implement support, the reader will create magnified instances with a magnification of 1/16. - By default this property is enabled. - - This property has been added in version 0.23.10. - """ - mebes_top_cell_index: int - r""" - Getter: - @brief Gets the cell index for the top cell to use - See \mebes_top_cell_index= for a description of this property. - - This property has been added in version 0.23.10. - - Setter: - @brief Specify the cell index for the top cell to use - If this property is set to a valid cell index, the MEBES reader will put the subcells and shapes into this cell. - - This property has been added in version 0.23.10. - """ oasis_expect_strict_mode: int r""" Getter: @@ -36847,6 +38145,14 @@ class LoadLayoutOptions: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LoadLayoutOptions: + 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 @@ -36882,6 +38188,11 @@ class LoadLayoutOptions: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LoadLayoutOptions: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -37001,26 +38312,6 @@ class LoadLayoutOptions: This method has been added in version 0.26.2. """ ... - def mebes_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.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion. - """ - ... - def mebes_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. - @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. - - This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion. - """ - ... def select_all_layers(self) -> None: r""" @brief Selects all layers and disables the layer map @@ -37151,6 +38442,14 @@ class LogEntryData: This method has been introduced in version 0.28.13. """ ... + def _const_cast(self) -> LogEntryData: + 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 @@ -37186,6 +38485,11 @@ class LogEntryData: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LogEntryData: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -37272,6 +38576,14 @@ class Manager: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Manager: + 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 @@ -37307,6 +38619,11 @@ class Manager: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Manager: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -37688,6 +39005,14 @@ class Matrix2d: @return The string representing this matrix """ ... + def _const_cast(self) -> Matrix2d: + 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 @@ -37723,6 +39048,11 @@ class Matrix2d: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Matrix2d: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -38196,6 +39526,14 @@ class Matrix3d: @return The string representing this matrix """ ... + def _const_cast(self) -> Matrix3d: + 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 @@ -38231,6 +39569,11 @@ class Matrix3d: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Matrix3d: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -38507,6 +39850,14 @@ class Metrics: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> Metrics: + 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 @@ -38542,6 +39893,11 @@ class Metrics: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Metrics: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -38657,6 +40013,14 @@ class Net(NetlistObject): @brief Assigns another object to self """ ... + def _const_cast(self) -> Net: + 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 @@ -38697,6 +40061,11 @@ class Net(NetlistObject): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Net: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -38856,6 +40225,14 @@ class NetElement: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetElement: + 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 @@ -38891,6 +40268,11 @@ class NetElement: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetElement: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -38993,6 +40375,14 @@ class NetPinRef: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetPinRef: + 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 @@ -39028,6 +40418,11 @@ class NetPinRef: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetPinRef: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -39076,15 +40471,15 @@ class NetPinRef: @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 """ ... @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. """ ... def pin(self) -> Pin: @@ -39127,6 +40522,14 @@ class NetSubcircuitPinRef: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetSubcircuitPinRef: + 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 @@ -39162,6 +40565,11 @@ class NetSubcircuitPinRef: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetSubcircuitPinRef: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -39277,6 +40685,14 @@ class NetTerminalRef: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetTerminalRef: + 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 @@ -39312,6 +40728,11 @@ class NetTerminalRef: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetTerminalRef: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -39468,6 +40889,14 @@ class NetTracer: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetTracer: + 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 @@ -39503,6 +40932,11 @@ class NetTracer: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetTracer: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -39674,6 +41108,14 @@ class NetTracerConnectionInfo: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetTracerConnectionInfo: + 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 @@ -39709,6 +41151,11 @@ class NetTracerConnectionInfo: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetTracerConnectionInfo: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -39825,6 +41272,14 @@ class NetTracerConnectivity: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetTracerConnectivity: + 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 @@ -39860,6 +41315,11 @@ class NetTracerConnectivity: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetTracerConnectivity: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -39965,6 +41425,14 @@ class NetTracerSymbolInfo: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetTracerSymbolInfo: + 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 @@ -40000,6 +41468,11 @@ class NetTracerSymbolInfo: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetTracerSymbolInfo: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -40077,6 +41550,14 @@ class NetTracerTechnologyComponent(TechnologyComponent): @brief Gets the connectivity definitions from the net tracer technology component. """ ... + def _const_cast(self) -> NetTracerTechnologyComponent: + 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 @@ -40112,6 +41593,11 @@ class NetTracerTechnologyComponent(TechnologyComponent): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetTracerTechnologyComponent: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -40202,6 +41688,14 @@ class Netlist: This method is intended for test purposes mainly. """ ... + def _const_cast(self) -> Netlist: + 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 @@ -40237,6 +41731,11 @@ class Netlist: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Netlist: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -40276,17 +41775,17 @@ class Netlist: @overload def circuit_by_cell_index(self, cell_index: int) -> Circuit: r""" - @brief Gets the circuit object for a given cell index. + @brief Gets the circuit object for a given cell index (const version). If the cell index is not valid or no circuit is registered with this index, nil is returned. + + This constness variant has been introduced in version 0.26.8. """ ... @overload def circuit_by_cell_index(self, cell_index: int) -> Circuit: r""" - @brief Gets the circuit object for a given cell index (const version). + @brief Gets the circuit object for a given cell index. If the cell index is not valid or no circuit is registered with this index, nil is returned. - - This constness variant has been introduced in version 0.26.8. """ ... @overload @@ -40308,20 +41807,20 @@ class Netlist: @overload def circuits_by_name(self, name_pattern: str) -> List[Circuit]: r""" - @brief Gets the circuit objects for a given name filter (const version). + @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 constness variant has been introduced in version 0.26.8. + This method has been introduced in version 0.26.4. """ ... @overload def circuits_by_name(self, name_pattern: str) -> List[Circuit]: r""" - @brief Gets the circuit objects for a given name filter. + @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. - This method has been introduced in version 0.26.4. + + This constness variant has been introduced in version 0.26.8. """ ... def combine_devices(self) -> None: @@ -40555,12 +42054,48 @@ class Netlist: This method is intended for test purposes mainly. """ ... + @overload + def top_circuit(self) -> Circuit: + r""" + @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. + """ + ... + @overload + def top_circuit(self) -> Circuit: + r""" + @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. + """ + ... def top_circuit_count(self) -> int: r""" @brief Gets the number of top circuits. Top circuits are those which are not referenced by other circuits via subcircuits. A well-formed netlist has a single top circuit. """ ... + @overload + def top_circuits(self) -> List[Circuit]: + r""" + @brief Gets the top circuits. + Returns a list of top circuits. + + This convenience method has been added in version 0.29.5. + """ + ... + @overload + def top_circuits(self) -> List[Circuit]: + r""" + @brief Gets the top circuits. + Returns a list of top circuits. + + This convenience method has been added in version 0.29.5. + """ + ... def write(self, file: str, writer: NetlistWriter, description: Optional[str] = ...) -> None: r""" @brief Writes the netlist to the given file using the given writer object to format the file @@ -40585,6 +42120,14 @@ class NetlistCompareLogger: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistCompareLogger: + 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 @@ -40620,6 +42163,11 @@ class NetlistCompareLogger: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistCompareLogger: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -40771,6 +42319,14 @@ class NetlistComparer: The logger is a delegate or event receiver which the comparer will send compare events to. See the class description for more details. """ ... + def _const_cast(self) -> NetlistComparer: + 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 @@ -40806,6 +42362,11 @@ class NetlistComparer: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistComparer: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -41319,6 +42880,14 @@ class NetlistCrossReference(NetlistCompareLogger): @brief Enum constant NetlistCrossReference::Skipped On circuits this code means that a match has not been attempted because subcircuits of this circuits were not matched. As circuit matching happens bottom-up, all subcircuits must match at least with respect to their pins to allow any parent circuit to be matched. """ + def _const_cast(self) -> NetlistCrossReference: + 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 @@ -41354,6 +42923,11 @@ class NetlistCrossReference(NetlistCompareLogger): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistCrossReference: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -41502,6 +43076,14 @@ class NetlistDeviceExtractorLayerDefinition: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistDeviceExtractorLayerDefinition: + 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 @@ -41537,6 +43119,11 @@ class NetlistDeviceExtractorLayerDefinition: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistDeviceExtractorLayerDefinition: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -41633,6 +43220,14 @@ class NetlistObject: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistObject: + 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 @@ -41668,6 +43263,11 @@ class NetlistObject: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistObject: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -41749,6 +43349,14 @@ class NetlistReader: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistReader: + 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 @@ -41784,6 +43392,11 @@ class NetlistReader: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistReader: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -41930,6 +43543,14 @@ class NetlistSpiceReader(NetlistReader): @brief Creates a new reader with a delegate. """ ... + def _const_cast(self) -> NetlistSpiceReader: + 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 @@ -41965,6 +43586,11 @@ class NetlistSpiceReader(NetlistReader): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistSpiceReader: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -42005,6 +43631,14 @@ class NetlistSpiceReaderDelegate: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistSpiceReaderDelegate: + 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 @@ -42040,6 +43674,11 @@ class NetlistSpiceReaderDelegate: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistSpiceReaderDelegate: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -42291,6 +43930,14 @@ class NetlistSpiceWriter(NetlistWriter): @brief Creates a new writer with a delegate. """ ... + def _const_cast(self) -> NetlistSpiceWriter: + 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 @@ -42326,6 +43973,11 @@ class NetlistSpiceWriter(NetlistWriter): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistSpiceWriter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -42376,6 +44028,14 @@ class NetlistSpiceWriterDelegate: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistSpiceWriterDelegate: + 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 @@ -42411,6 +44071,11 @@ class NetlistSpiceWriterDelegate: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistSpiceWriterDelegate: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -42512,6 +44177,14 @@ class NetlistWriter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> NetlistWriter: + 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 @@ -42547,6 +44220,11 @@ class NetlistWriter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> NetlistWriter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -42614,6 +44292,14 @@ class PCellDeclaration(PCellDeclaration_Native): @brief Assigns another object to self """ ... + def _const_cast(self) -> PCellDeclaration: + 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 @@ -42654,6 +44340,11 @@ class PCellDeclaration(PCellDeclaration_Native): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PCellDeclaration: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -42730,6 +44421,14 @@ class PCellDeclaration_Native: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PCellDeclaration_Native: + 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 @@ -42765,6 +44464,11 @@ class PCellDeclaration_Native: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PCellDeclaration_Native: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -43061,6 +44765,14 @@ class PCellParameterDeclaration: @param unit The unit string """ ... + def _const_cast(self) -> PCellParameterDeclaration: + 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 @@ -43096,6 +44808,11 @@ class PCellParameterDeclaration: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PCellParameterDeclaration: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -43315,13 +45032,6 @@ class PCellParameterState: r""" @brief An icon indicating a warning is shown """ - @property - def icon(self) -> None: - r""" - WARNING: This variable can only be set, not retrieved. - @brief Sets the icon for the parameter - """ - ... enabled: bool r""" Getter: @@ -43330,6 +45040,14 @@ class PCellParameterState: Setter: @brief Sets a value indicating whether the parameter is enabled in the parameter form """ + icon: PCellParameterState.ParameterStateIcon + r""" + Getter: + @brief Gets the icon for the parameter + + Setter: + @brief Sets the icon for the parameter + """ readonly: bool r""" Getter: @@ -43385,6 +45103,14 @@ class PCellParameterState: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PCellParameterState: + 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 @@ -43420,6 +45146,11 @@ class PCellParameterState: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PCellParameterState: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -43516,6 +45247,14 @@ class PCellParameterStates: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PCellParameterStates: + 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 @@ -43551,6 +45290,11 @@ class PCellParameterStates: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PCellParameterStates: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -43647,6 +45391,14 @@ class ParentInstArray: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ParentInstArray: + 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 @@ -43682,6 +45434,11 @@ class ParentInstArray: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ParentInstArray: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -43797,6 +45554,14 @@ class ParseElementComponentsData: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ParseElementComponentsData: + 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 @@ -43832,6 +45597,11 @@ class ParseElementComponentsData: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ParseElementComponentsData: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -43939,6 +45709,14 @@ class ParseElementData: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ParseElementData: + 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 @@ -43974,6 +45752,11 @@ class ParseElementData: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ParseElementData: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -44290,6 +46073,14 @@ class Path: @brief Convert to a string """ ... + def _const_cast(self) -> Path: + 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 @@ -44325,6 +46116,11 @@ class Path: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Path: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -44581,6 +46377,14 @@ class Pin(NetlistObject): @brief Assigns another object to self """ ... + def _const_cast(self) -> Pin: + 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 @@ -44621,6 +46425,11 @@ class Pin(NetlistObject): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Pin: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -44886,6 +46695,14 @@ class Point: Returns the scaled object. All coordinates are divided with the given divisor and if necessary rounded. """ ... + def _const_cast(self) -> Point: + 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 @@ -44921,6 +46738,11 @@ class Point: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Point: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -45306,6 +47128,14 @@ class Polygon: @brief Returns a string representing the polygon """ ... + def _const_cast(self) -> Polygon: + 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 @@ -45341,6 +47171,11 @@ class Polygon: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Polygon: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -46221,6 +48056,14 @@ class PolygonFilter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PolygonFilter: + 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 @@ -46256,6 +48099,11 @@ class PolygonFilter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PolygonFilter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -46422,6 +48270,14 @@ class PolygonOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PolygonOperator: + 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 @@ -46457,6 +48313,11 @@ class PolygonOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PolygonOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -46603,6 +48464,14 @@ class PolygonToEdgeOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PolygonToEdgeOperator: + 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 @@ -46638,6 +48507,11 @@ class PolygonToEdgeOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PolygonToEdgeOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -46784,6 +48658,14 @@ class PolygonToEdgePairOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PolygonToEdgePairOperator: + 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 @@ -46819,6 +48701,11 @@ class PolygonToEdgePairOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PolygonToEdgePairOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -46998,6 +48885,14 @@ class PreferredOrientation: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> PreferredOrientation: + 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 @@ -47033,6 +48928,11 @@ class PreferredOrientation: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PreferredOrientation: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -47228,6 +49128,14 @@ class PropertyConstraint: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> PropertyConstraint: + 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 @@ -47263,6 +49171,11 @@ class PropertyConstraint: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PropertyConstraint: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -47604,6 +49517,14 @@ class RecursiveInstanceIterator: Two iterators are not equal if they do not point to the same instance. """ ... + def _const_cast(self) -> RecursiveInstanceIterator: + 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 @@ -47639,6 +49560,11 @@ class RecursiveInstanceIterator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RecursiveInstanceIterator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -48346,6 +50272,14 @@ class RecursiveShapeIterator: Two iterators are not equal if they do not point to the same shape. """ ... + def _const_cast(self) -> RecursiveShapeIterator: + 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 @@ -48381,6 +50315,11 @@ class RecursiveShapeIterator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RecursiveShapeIterator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -49802,6 +51741,14 @@ class Region(ShapeCollection): The 'xor' alias has been introduced in version 0.28.12. """ ... + def _const_cast(self) -> Region: + 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 @@ -49837,6 +51784,11 @@ class Region(ShapeCollection): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Region: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -49910,6 +51862,32 @@ class Region(ShapeCollection): The bounding box is the box enclosing all points of all polygons. """ ... + def begin_merged_shapes_rec(self) -> Any: + r""" + @brief Returns a recursive shape iterator plus a transformation for the shapes constituting the merged region. + It can be used like \begin_shapes_rec, but delivers shapes from the merged polygons pool. + + This speciality method was introduced in version 0.29.5. + """ + ... + def begin_shapes_rec(self) -> Any: + r""" + @brief Returns a recursive shape iterator plus a transformation for the shapes constituting this region. + This method returns a pair consisting of a \RecursiveShapeIterator plus a \ICplxTrans transformation. Both objects allow accessing the shapes (polygons) of the region in a detailed fashion. To iterate the the polygons use a code like this: + + @code + iter, trans = region.begin_shapes_rec + iter.each do |i| + polygon = trans * iter.trans * i.shape.polygon + ... + end + @/code + + This method is the most powerful way of accessing the shapes inside the region. I allows for example to obtain the properties attached to the polygons of the region. It is primarily intended for special applications like iterating net-annotated shapes. + + This speciality method was introduced in version 0.29.5. + """ + ... def break_(self, max_vertex_count: int, max_area_ratio: Optional[float] = ...) -> None: r""" @brief Breaks the polygons of the region into smaller ones @@ -49918,7 +51896,18 @@ class Region(ShapeCollection): Using a value of 0 for either limit means that the respective limit isn't checked. Breaking happens by cutting the polygons into parts at 'good' locations. The algorithm does not have a specific goal to minimize the number of parts for example. The only goal is to achieve parts within the given limits. - This method has been introduced in version 0.26. + This method has been introduced in version 0.26. The 'break_polygons' alias has been introduced in version 0.29.5 to avoid issues with reserved keywords. + """ + ... + def break_polygons(self, max_vertex_count: int, max_area_ratio: Optional[float] = ...) -> None: + r""" + @brief Breaks the polygons of the region into smaller ones + + There are two criteria for splitting a polygon: a polygon is split into parts with less then 'max_vertex_count' points and an bounding box-to-polygon area ratio less than 'max_area_ratio'. The area ratio is supposed to render polygons whose bounding box is a better approximation. This applies for example to 'L' shape polygons. + + Using a value of 0 for either limit means that the respective limit isn't checked. Breaking happens by cutting the polygons into parts at 'good' locations. The algorithm does not have a specific goal to minimize the number of parts for example. The only goal is to achieve parts within the given limits. + + This method has been introduced in version 0.26. The 'break_polygons' alias has been introduced in version 0.29.5 to avoid issues with reserved keywords. """ ... def clear(self) -> None: @@ -50066,6 +52055,8 @@ class Region(ShapeCollection): Refinement is implemented by Chew's second algorithm. A maximum area can be given. Triangles larger than this area will be split. In addition 'skinny' triangles will be resolved where possible. 'skinny' is defined in terms of shortest edge to circumcircle radius ratio (b). A minimum number for b can be given. The default of 1.0 corresponds to a minimum angle of 30 degree and is usually a good choice. The algorithm is stable up to roughly 1.2 which corresponds to a minimum angle of abouth 37 degree. + The minimum angle of the resulting triangles relates to the 'b' parameter as: @t min_angle = arcsin(B/2) @/t. + The area value is given in terms of DBU units. Picking a value of 0.0 for area and min b will make the implementation skip the refinement step. In that case, the results are identical to the standard constrained Delaunay triangulation. Note that the result is a region in raw mode as otherwise the triangles are likely to get merged later on. @@ -50968,7 +52959,7 @@ class Region(ShapeCollection): metal1_all_nets = metal1.nets @/code - This method was introduced in version 0.28.4 + This method was introduced in version 0.28.4. """ ... def non_rectangles(self) -> Region: @@ -53061,6 +55052,14 @@ class SaveLayoutOptions: The default format is GDS2. """ ... + def _const_cast(self) -> SaveLayoutOptions: + 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 @@ -53096,6 +55095,11 @@ class SaveLayoutOptions: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> SaveLayoutOptions: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -53360,6 +55364,14 @@ class Severity: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> Severity: + 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 @@ -53395,6 +55407,11 @@ class Severity: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Severity: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -54040,10 +56057,11 @@ class Shape: Starting with version 0.23, this method returns nil, if the shape does not represent a geometrical primitive that can be converted to a polygon. Setter: - @brief Replaces the shape by the given polygon (in micrometer units) - This method replaces the shape by the given polygon, like \polygon= with a \Polygon argument does. This version translates the polygon from micrometer units to database units internally. + @brief Replaces the shape by the given polygon object + This method replaces the shape by the given polygon 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. - This method has been introduced in version 0.25. + This method has been introduced in version 0.22. """ prop_id: int r""" @@ -54461,6 +56479,14 @@ class Shape: This method has been introduced with version 0.16. """ ... + def _const_cast(self) -> Shape: + 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 @@ -54496,6 +56522,11 @@ class Shape: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Shape: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -54851,6 +56882,14 @@ class Shape: This method has been added in version 0.23. """ ... + def properties(self) -> Any: + r""" + @brief Gets the user properties + This method is a convenience method that gets the properties of the shape as a single hash. + + This method has been introduced in version 0.29.5. + """ + ... def property(self, key: Any) -> Any: r""" @brief Gets the user property with the given key @@ -54946,6 +56985,14 @@ class ShapeCollection: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ShapeCollection: + 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 @@ -54981,6 +57028,11 @@ class ShapeCollection: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ShapeCollection: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -55045,6 +57097,14 @@ class ShapeProcessor: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ShapeProcessor: + 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 @@ -55080,6 +57140,11 @@ class ShapeProcessor: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ShapeProcessor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -55634,6 +57699,14 @@ class Shapes: @return The number of shapes in this container """ ... + def _const_cast(self) -> Shapes: + 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 @@ -55669,6 +57742,11 @@ class Shapes: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Shapes: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -55682,6 +57760,19 @@ class Shapes: @brief Assigns another object to self """ ... + def break_polygons(self, max_vertex_count: int, max_area_ratio: Optional[float] = ...) -> None: + r""" + @brief Breaks the polygons of the shape container into smaller ones + + There are two criteria for splitting a polygon: a polygon is split into parts with less then 'max_vertex_count' points and an bounding box-to-polygon area ratio less than 'max_area_ratio'. The area ratio is supposed to render polygons whose bounding box is a better approximation. This applies for example to 'L' shape polygons. + + Using a value of 0 for either limit means that the respective limit isn't checked. Breaking happens by cutting the polygons into parts at 'good' locations. The algorithm does not have a specific goal to minimize the number of parts for example. The only goal is to achieve parts within the given limits. + + Breaking also applies to paths if their polygon representation satisfies the breaking criterion. In that case, paths are converted to polygons and broken into smaller parts. + + This method has been introduced in version 0.29.5. + """ + ... def cell(self) -> Cell: r""" @brief Gets the cell the shape container belongs to @@ -57086,6 +59177,14 @@ class SimplePolygon: @brief Returns a string representing the polygon """ ... + def _const_cast(self) -> SimplePolygon: + 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 @@ -57121,6 +59220,11 @@ class SimplePolygon: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> SimplePolygon: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -57677,6 +59781,14 @@ class SubCircuit(NetlistObject): @brief Assigns another object to self """ ... + def _const_cast(self) -> SubCircuit: + 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 @@ -57717,6 +59829,11 @@ class SubCircuit(NetlistObject): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> SubCircuit: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -57728,17 +59845,17 @@ class SubCircuit(NetlistObject): @overload def circuit(self) -> Circuit: r""" - @brief Gets the circuit the subcircuit lives in. + @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 (non-const version). + @brief Gets the circuit the subcircuit lives in. 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 @@ -58066,6 +60183,14 @@ class Technology: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Technology: + 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 @@ -58101,6 +60226,11 @@ class Technology: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Technology: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -58250,6 +60380,14 @@ class TechnologyComponent: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TechnologyComponent: + 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 @@ -58285,6 +60423,11 @@ class TechnologyComponent: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TechnologyComponent: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -58397,7 +60540,8 @@ class Text: 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: int r""" @@ -58433,8 +60577,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""" @@ -58619,6 +60762,14 @@ class Text: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> Text: + 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 @@ -58654,6 +60805,11 @@ class Text: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Text: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -58899,6 +61055,14 @@ class TextFilter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TextFilter: + 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 @@ -58934,6 +61098,11 @@ class TextFilter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TextFilter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -59104,6 +61273,14 @@ class TextGenerator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TextGenerator: + 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 @@ -59139,6 +61316,11 @@ class TextGenerator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TextGenerator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -59360,6 +61542,14 @@ class TextOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TextOperator: + 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 @@ -59395,6 +61585,11 @@ class TextOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TextOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -59501,6 +61696,14 @@ class TextToPolygonOperator: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TextToPolygonOperator: + 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 @@ -59536,6 +61739,11 @@ class TextToPolygonOperator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TextToPolygonOperator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -59912,6 +62120,14 @@ class Texts(ShapeCollection): @return A new text collection containing the texts not inside or on the edge of polygons from the region """ ... + def _const_cast(self) -> Texts: + 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 @@ -59947,6 +62163,11 @@ class Texts(ShapeCollection): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Texts: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -60433,6 +62654,14 @@ class TileOutputReceiver(TileOutputReceiverBase): @brief Assigns another object to self """ ... + def _const_cast(self) -> TileOutputReceiver: + 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 @@ -60473,6 +62702,11 @@ class TileOutputReceiver(TileOutputReceiverBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TileOutputReceiver: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -60509,6 +62743,14 @@ class TileOutputReceiverBase: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TileOutputReceiverBase: + 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 @@ -60544,6 +62786,11 @@ class TileOutputReceiverBase: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TileOutputReceiverBase: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -60722,6 +62969,14 @@ class TilingProcessor: @brief Creates a new object of this class """ ... + def _const_cast(self) -> TilingProcessor: + 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 @@ -60757,6 +63012,11 @@ class TilingProcessor: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TilingProcessor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -61745,6 +64005,14 @@ class Trans: The DBU argument has been added in version 0.27.6. """ ... + def _const_cast(self) -> Trans: + 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 @@ -61780,6 +64048,11 @@ class Trans: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Trans: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -62094,6 +64367,14 @@ class TrapezoidDecompositionMode: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> TrapezoidDecompositionMode: + 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 @@ -62129,6 +64410,11 @@ class TrapezoidDecompositionMode: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> TrapezoidDecompositionMode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -62274,6 +64560,14 @@ class Utils: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Utils: + 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 @@ -62309,6 +64603,11 @@ class Utils: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Utils: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -62469,6 +64768,14 @@ class VAlign: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> VAlign: + 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 @@ -62504,6 +64811,11 @@ class VAlign: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> VAlign: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -63249,6 +65561,14 @@ class VCplxTrans: The lazy and DBU arguments have been added in version 0.27.6. """ ... + def _const_cast(self) -> VCplxTrans: + 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 @@ -63284,6 +65604,11 @@ class VCplxTrans: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> VCplxTrans: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -63813,6 +66138,14 @@ class Vector: Returns the scaled object. All coordinates are divided with the given divisor and if necessary rounded. """ ... + def _const_cast(self) -> Vector: + 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 @@ -63848,6 +66181,11 @@ class Vector: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Vector: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -64104,6 +66442,14 @@ class ZeroDistanceMode: @brief Gets the symbolic string from an enum """ ... + def _const_cast(self) -> ZeroDistanceMode: + 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 @@ -64139,6 +66485,11 @@ class ZeroDistanceMode: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ZeroDistanceMode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. diff --git a/src/pymod/distutils_src/klayout/laycore.pyi b/src/pymod/distutils_src/klayout/laycore.pyi index 2ca5ae930..985882bfd 100644 --- a/src/pymod/distutils_src/klayout/laycore.pyi +++ b/src/pymod/distutils_src/klayout/laycore.pyi @@ -92,6 +92,14 @@ class AbstractMenu: @hide """ ... + def _const_cast(self) -> AbstractMenu: + 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 @@ -127,6 +135,11 @@ class AbstractMenu: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> AbstractMenu: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -315,6 +328,14 @@ class Action(ActionBase): In Version 0.23, the Action class has been merged with the ActionBase class. """ + def _const_cast(self) -> Action: + 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 @@ -350,6 +371,11 @@ class Action(ActionBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Action: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -552,6 +578,14 @@ class ActionBase: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ActionBase: + 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 @@ -587,6 +621,11 @@ class ActionBase: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ActionBase: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1268,6 +1307,14 @@ class Annotation(BasicAnnotation): @brief Assigns another object to self """ ... + def _const_cast(self) -> Annotation: + 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 @@ -1308,6 +1355,11 @@ class Annotation(BasicAnnotation): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Annotation: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1483,6 +1535,14 @@ class BasicAnnotation: @brief Creates a new object of this class """ ... + def _const_cast(self) -> BasicAnnotation: + 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 @@ -1518,6 +1578,11 @@ class BasicAnnotation: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> BasicAnnotation: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1591,6 +1656,14 @@ class BasicImage: @brief Creates a new object of this class """ ... + def _const_cast(self) -> BasicImage: + 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 @@ -1626,6 +1699,11 @@ class BasicImage: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> BasicImage: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1739,6 +1817,14 @@ class BitmapBuffer: @brief Returns a value indicating whether self is not identical to the other image """ ... + def _const_cast(self) -> BitmapBuffer: + 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 @@ -1774,6 +1860,11 @@ class BitmapBuffer: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> BitmapBuffer: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1920,6 +2011,14 @@ class ButtonState: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ButtonState: + 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 @@ -1955,6 +2054,11 @@ class ButtonState: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ButtonState: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2173,6 +2277,14 @@ class CellView: @brief Creates a new object of this class """ ... + def _const_cast(self) -> CellView: + 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 @@ -2208,6 +2320,11 @@ class CellView: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> CellView: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2527,6 +2644,14 @@ class Cursor: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Cursor: + 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 @@ -2562,6 +2687,11 @@ class Cursor: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Cursor: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2638,6 +2768,14 @@ class Dispatcher: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Dispatcher: + 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 @@ -2673,6 +2811,11 @@ class Dispatcher: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Dispatcher: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2936,6 +3079,14 @@ class EditorHooks: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EditorHooks: + 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 @@ -2971,6 +3122,11 @@ class EditorHooks: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EditorHooks: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -3488,6 +3644,14 @@ class Image(BasicImage): @brief Assigns another object to self """ ... + def _const_cast(self) -> Image: + 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 @@ -3528,6 +3692,11 @@ class Image(BasicImage): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Image: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -3909,6 +4078,14 @@ class ImageDataMapping: @brief Create a new data mapping object with default settings """ ... + def _const_cast(self) -> ImageDataMapping: + 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 @@ -3944,6 +4121,11 @@ class ImageDataMapping: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ImageDataMapping: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -4154,6 +4336,14 @@ class KeyCode: @brief Creates a new object of this class """ ... + def _const_cast(self) -> KeyCode: + 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 @@ -4189,6 +4379,11 @@ class KeyCode: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> KeyCode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -4585,6 +4780,14 @@ class LayerProperties: @param other The other object to compare against """ ... + def _const_cast(self) -> LayerProperties: + 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 @@ -4620,6 +4823,11 @@ class LayerProperties: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerProperties: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -5111,6 +5319,14 @@ class LayerPropertiesIterator: @param other The other object to compare against """ ... + def _const_cast(self) -> LayerPropertiesIterator: + 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 @@ -5146,6 +5362,11 @@ class LayerPropertiesIterator: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerPropertiesIterator: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -5355,6 +5576,14 @@ class LayerPropertiesNode(LayerProperties): @brief Assigns another object to self """ ... + def _const_cast(self) -> LayerPropertiesNode: + 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 @@ -5395,6 +5624,11 @@ class LayerPropertiesNode(LayerProperties): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerPropertiesNode: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -5522,6 +5756,14 @@ class LayerPropertiesNodeRef(LayerPropertiesNode): @brief Assigns another object to self """ ... + def _const_cast(self) -> LayerPropertiesNodeRef: + 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 @@ -5562,6 +5804,11 @@ class LayerPropertiesNodeRef(LayerPropertiesNode): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayerPropertiesNodeRef: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -5678,6 +5925,14 @@ class LayoutView(LayoutViewBase): It has been enhanced with the arguments in version 0.27. """ ... + def _const_cast(self) -> LayoutView: + 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 @@ -5713,6 +5968,11 @@ class LayoutView(LayoutViewBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutView: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -6428,6 +6688,14 @@ class LayoutViewBase: @brief Creates a new object of this class """ ... + def _const_cast(self) -> LayoutViewBase: + 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 @@ -6463,6 +6731,11 @@ class LayoutViewBase: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> LayoutViewBase: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -8760,6 +9033,14 @@ class Macro: This constructor has been introduced in version 0.27.5. """ ... + def _const_cast(self) -> Macro: + 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 @@ -8795,6 +9076,11 @@ class Macro: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Macro: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -8933,6 +9219,14 @@ class MacroExecutionContext: @brief Creates a new object of this class """ ... + def _const_cast(self) -> MacroExecutionContext: + 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 @@ -8968,6 +9262,11 @@ class MacroExecutionContext: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> MacroExecutionContext: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -9200,6 +9499,14 @@ class MacroInterpreter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> MacroInterpreter: + 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 @@ -9235,6 +9542,11 @@ class MacroInterpreter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> MacroInterpreter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -9438,6 +9750,14 @@ class Marker: The 'view' argument is optional since version 0.29.3. """ ... + def _const_cast(self) -> Marker: + 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 @@ -9473,6 +9793,11 @@ class Marker: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Marker: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -9797,6 +10122,14 @@ class ObjectInstPath: This method has been introduced with version 0.24. """ ... + def _const_cast(self) -> ObjectInstPath: + 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 @@ -9832,6 +10165,11 @@ class ObjectInstPath: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ObjectInstPath: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -10105,6 +10443,14 @@ class PixelBuffer: @brief Returns a value indicating whether self is not identical to the other image """ ... + def _const_cast(self) -> PixelBuffer: + 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 @@ -10140,6 +10486,11 @@ class PixelBuffer: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PixelBuffer: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -10262,6 +10613,14 @@ class Plugin: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Plugin: + 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 @@ -10297,6 +10656,11 @@ class Plugin: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Plugin: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -10450,6 +10814,14 @@ class PluginFactory: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PluginFactory: + 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 @@ -10485,6 +10857,11 @@ class PluginFactory: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PluginFactory: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. diff --git a/src/pymod/distutils_src/klayout/rdbcore.pyi b/src/pymod/distutils_src/klayout/rdbcore.pyi index a2b846e97..423b6ba4d 100644 --- a/src/pymod/distutils_src/klayout/rdbcore.pyi +++ b/src/pymod/distutils_src/klayout/rdbcore.pyi @@ -29,6 +29,14 @@ class RdbCategory: @brief Creates a new object of this class """ ... + def _const_cast(self) -> RdbCategory: + 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 @@ -64,6 +72,11 @@ class RdbCategory: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RdbCategory: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -270,6 +283,14 @@ class RdbCell: @brief Creates a new object of this class """ ... + def _const_cast(self) -> RdbCell: + 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 @@ -305,6 +326,11 @@ class RdbCell: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RdbCell: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -515,6 +541,14 @@ class RdbItem: @brief Creates a new object of this class """ ... + def _const_cast(self) -> RdbItem: + 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 @@ -550,6 +584,11 @@ class RdbItem: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RdbItem: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -910,6 +949,14 @@ class RdbItemValue: @return The string """ ... + def _const_cast(self) -> RdbItemValue: + 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 @@ -945,6 +992,11 @@ class RdbItemValue: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RdbItemValue: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1140,6 +1192,14 @@ class RdbReference: @brief Creates a reference with a given transformation and parent cell ID """ ... + def _const_cast(self) -> RdbReference: + 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 @@ -1175,6 +1235,11 @@ class RdbReference: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RdbReference: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1313,6 +1378,14 @@ class ReportDatabase: The name of the database will be used in the user interface to refer to a certain database. """ ... + def _const_cast(self) -> ReportDatabase: + 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 @@ -1348,6 +1421,11 @@ class ReportDatabase: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ReportDatabase: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. diff --git a/src/pymod/distutils_src/klayout/tlcore.pyi b/src/pymod/distutils_src/klayout/tlcore.pyi index 573b3919f..329f26df3 100644 --- a/src/pymod/distutils_src/klayout/tlcore.pyi +++ b/src/pymod/distutils_src/klayout/tlcore.pyi @@ -106,6 +106,14 @@ class AbsoluteProgress(Progress): The yield interval specifies, how often the event loop will be triggered. When the yield interval is 10 for example, the event loop will be executed every tenth call of \inc or \set. """ ... + def _const_cast(self) -> AbsoluteProgress: + 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 @@ -141,6 +149,11 @@ class AbsoluteProgress(Progress): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> AbsoluteProgress: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -205,6 +218,14 @@ class AbstractProgress(Progress): @brief Creates an abstract progress reporter with the given description """ ... + def _const_cast(self) -> AbstractProgress: + 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 @@ -240,6 +261,11 @@ class AbstractProgress(Progress): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> AbstractProgress: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -371,6 +397,14 @@ class ArgType: @brief Convert to a string """ ... + def _const_cast(self) -> ArgType: + 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 @@ -406,6 +440,11 @@ class ArgType: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ArgType: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -556,6 +595,14 @@ class Class: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Class: + 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 @@ -591,6 +638,11 @@ class Class: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Class: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -712,6 +764,14 @@ class EmptyClass: @brief Creates a new object of this class """ ... + def _const_cast(self) -> EmptyClass: + 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 @@ -747,6 +807,11 @@ class EmptyClass: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> EmptyClass: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -808,6 +873,14 @@ class Executable(ExecutableBase): @brief Assigns another object to self """ ... + def _const_cast(self) -> Executable: + 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 @@ -848,6 +921,11 @@ class Executable(ExecutableBase): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Executable: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -884,6 +962,14 @@ class ExecutableBase: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ExecutableBase: + 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 @@ -919,6 +1005,11 @@ class ExecutableBase: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ExecutableBase: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1025,6 +1116,14 @@ class Expression(ExpressionContext): This version of the constructor takes a hash of variables available to the expressions. """ ... + def _const_cast(self) -> Expression: + 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 @@ -1065,6 +1164,11 @@ class Expression(ExpressionContext): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Expression: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1115,6 +1219,14 @@ class ExpressionContext: @brief Creates a new object of this class """ ... + def _const_cast(self) -> ExpressionContext: + 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 @@ -1150,6 +1262,11 @@ class ExpressionContext: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> ExpressionContext: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1252,6 +1369,14 @@ class GlobPattern: @brief Creates a new glob pattern match object """ ... + def _const_cast(self) -> GlobPattern: + 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 @@ -1287,6 +1412,11 @@ class GlobPattern: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> GlobPattern: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1382,6 +1512,14 @@ class Interpreter: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Interpreter: + 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 @@ -1417,6 +1555,11 @@ class Interpreter: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Interpreter: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1552,6 +1695,14 @@ class Logger: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Logger: + 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 @@ -1587,6 +1738,11 @@ class Logger: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Logger: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1675,6 +1831,14 @@ class Method: This method has been introduced in version 0.29. """ ... + def _const_cast(self) -> Method: + 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 @@ -1710,6 +1874,11 @@ class Method: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Method: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -1881,6 +2050,14 @@ class MethodOverload: @brief Creates a new object of this class """ ... + def _const_cast(self) -> MethodOverload: + 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 @@ -1916,6 +2093,11 @@ class MethodOverload: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> MethodOverload: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2027,6 +2209,14 @@ class Progress: @brief Creates a new object of this class """ ... + def _const_cast(self) -> Progress: + 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 @@ -2062,6 +2252,11 @@ class Progress: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Progress: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2124,6 +2319,14 @@ class PythonFunction: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PythonFunction: + 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 @@ -2159,6 +2362,11 @@ class PythonFunction: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PythonFunction: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2251,6 +2459,14 @@ class PythonGetterSetterPair: @brief Creates a new object of this class """ ... + def _const_cast(self) -> PythonGetterSetterPair: + 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 @@ -2286,6 +2502,11 @@ class PythonGetterSetterPair: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> PythonGetterSetterPair: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2382,6 +2603,14 @@ class Recipe: @brief Creates a new recipe object with the given name and (optional) description """ ... + def _const_cast(self) -> Recipe: + 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 @@ -2417,6 +2646,11 @@ class Recipe: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Recipe: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2560,6 +2794,14 @@ class RelativeProgress(Progress): The yield interval specifies, how often the event loop will be triggered. When the yield interval is 10 for example, the event loop will be executed every tenth call of \inc or \set. """ ... + def _const_cast(self) -> RelativeProgress: + 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 @@ -2595,6 +2837,11 @@ class RelativeProgress(Progress): Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> RelativeProgress: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2685,6 +2932,14 @@ class Timer: @brief Produces a string with the currently elapsed times """ ... + def _const_cast(self) -> Timer: + 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 @@ -2720,6 +2975,11 @@ class Timer: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Timer: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side. @@ -2860,6 +3120,14 @@ class Value: @brief Convert this object to a string """ ... + def _const_cast(self) -> Value: + 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 @@ -2895,6 +3163,11 @@ class Value: Usually it's not required to call this method. It has been introduced in version 0.24. """ ... + def _to_const_object(self) -> Value: + r""" + @hide + """ + ... def _unmanage(self) -> None: r""" @brief Marks the object as no longer owned by the script side.