Notation used in Ruby API documentation
Module: db
Description: A device extractor for a capacitor with a bulk terminal
Class hierarchy: DeviceExtractorCapacitorWithBulk » DeviceExtractorBase
This class supplies the generic extractor for a capacitor device including a bulk terminal. The device is defined the same way than devices are defined for DeviceExtractorCapacitor.
The device class produced by this extractor is DeviceClassCapacitorWithBulk. The extractor produces three parameters:
The device layer names are:
The terminals are output on these layers:
The bulk terminal layer can be an empty layer representing the substrate. In this case, it needs to be connected globally.
This class is a closed one and methods cannot be reimplemented. To reimplement specific methods, see DeviceExtractor.
This class has been introduced in version 0.26.
| new DeviceExtractorCapacitorWithBulk ptr | new | (string name, double sheet_rho, DeviceClassFactory ptr factory = none) | Creates a new device extractor with the given name |
| [const] | DeviceExtractorCapacitorWithBulk ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. |
_const_cast | Signature: [const] DeviceExtractorCapacitorWithBulk ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
new | Signature: [static] new DeviceExtractorCapacitorWithBulk ptr new (string name, double sheet_rho, DeviceClassFactory ptr factory = none) Description: Creates a new device extractor with the given name For the 'factory' parameter see DeviceClassFactory. It has been added in version 0.27.3. Python specific notes: |