Notation used in Ruby API documentation
Module: db
Description: Provides a delegate for the SPICE writer for doing special formatting for devices
Supply a customized class to provide a specialized writing scheme for devices. You need a customized class if you want to implement special devices or you want to use subcircuits rather than the built-in devices.
See NetlistSpiceWriter for more details.
This class has been introduced in version 0.26.
| new NetlistSpiceWriterDelegate ptr | new | Creates a new object of this class |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const NetlistSpiceWriterDelegate other) | Assigns another object to self | |
| [const] | new NetlistSpiceWriterDelegate ptr | dup | Creates a copy of self | |
| [const] | void | emit_comment | (string comment) | Writes the given comment into the file |
| [const] | void | emit_line | (string line) | Writes the given line into the file |
| [const] | string | format_name | (string name) | Formats the given name in a SPICE-compatible way |
| [const] | string | net_to_string | (const Net ptr net) | Gets the node ID for the given net |
| [virtual,const] | void | write_device | (Device device) | Inserts a text for the given device |
| [virtual,const] | void | write_device_intro | (DeviceClass device_class) | Inserts a text for the given device class |
| [virtual,const] | void | write_header | Writes the text at the beginning of the SPICE netlist |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
assign | Signature: void assign (const NetlistSpiceWriterDelegate other) Description: Assigns another object to self |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
dup | Signature: [const] new NetlistSpiceWriterDelegate ptr dup Description: Creates a copy of self Python specific notes: |
emit_comment | Signature: [const] void emit_comment (string comment) Description: Writes the given comment into the file |
emit_line | Signature: [const] void emit_line (string line) Description: Writes the given line into the file |
format_name | Signature: [const] string format_name (string name) Description: Formats the given name in a SPICE-compatible way |
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
net_to_string | Signature: [const] string net_to_string (const Net ptr net) Description: Gets the node ID for the given net The node ID is a numeric string instead of the full name of the net. Numeric IDs are used within SPICE netlist because they are usually shorter. |
new | Signature: [static] new NetlistSpiceWriterDelegate ptr new Description: Creates a new object of this class Python specific notes: |
write_device | Signature: [virtual,const] void write_device (Device device) Description: Inserts a text for the given device Reimplement this method to write the given device in the desired way. The default implementation will utilize the device class information to write native SPICE elements for the devices. |
write_device_intro | Signature: [virtual,const] void write_device_intro (DeviceClass device_class) Description: Inserts a text for the given device class Reimplement this method to insert your own text at the beginning of the file for the given device class |
write_header | Signature: [virtual,const] void write_header Description: Writes the text at the beginning of the SPICE netlist Reimplement this method to insert your own text at the beginning of the file |