Notation used in Ruby API documentation
Module: db
Description: Implements a netlist writer for the SPICE format.
Class hierarchy: NetlistSpiceWriter » NetlistWriter
Provide a delegate for customizing the way devices are written.
Use the SPICE writer like this:
writer = RBA::NetlistSpiceWriter::new netlist.write(path, writer)
You can give a custom description for the headline:
writer = RBA::NetlistSpiceWriter::new netlist.write(path, writer, "A custom description")
To customize the output, you can use a device writer delegate. The delegate is an object of a class derived from NetlistSpiceWriterDelegate which reimplements several methods to customize the following parts:
The delegate must use NetlistSpiceWriterDelegate#emit_line to print a line, NetlistSpiceWriterDelegate#emit_comment to print a comment etc. For more method see NetlistSpiceWriterDelegate.
A sample with a delegate is this:
class MyDelegate < RBA::NetlistSpiceWriterDelegate
def write_header
emit_line("*** My special header")
end
def write_device_intro(cls)
emit_comment("My intro for class " + cls.name)
end
def write_device(dev)
if dev.device_class.name != "MYDEVICE"
emit_comment("Terminal #1: " + net_to_string(dev.net_for_terminal(0)))
emit_comment("Terminal #2: " + net_to_string(dev.net_for_terminal(1)))
super(dev)
emit_comment("After device " + dev.expanded_name)
else
super(dev)
end
end
end
# write the netlist with delegate:
writer = RBA::NetlistSpiceWriter::new(MyDelegate::new)
netlist.write(path, writer)
This class has been introduced in version 0.26.
| new NetlistSpiceWriter ptr | new | Creates a new writer without delegate. | |
| new NetlistSpiceWriter ptr | new | (NetlistSpiceWriterDelegate ptr delegate) | Creates a new writer with a delegate. |
| [const] | NetlistSpiceWriter ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const NetlistSpiceWriter other) | Assigns another object to self | |
| [const] | new NetlistSpiceWriter ptr | dup | Creates a copy of self | |
| void | use_net_names= | (bool f) | Sets a value indicating whether to use net names (true) or net numbers (false). | |
| [const] | bool | use_net_names? | Gets a value indicating whether to use net names (true) or net numbers (false). | |
| void | with_comments= | (bool f) | Sets a value indicating whether to embed comments for position etc. (true) or not (false). | |
| [const] | bool | with_comments? | Gets a value indicating whether to embed comments for position etc. (true) or not (false). |
_const_cast | Signature: [const] NetlistSpiceWriter ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
assign | Signature: void assign (const NetlistSpiceWriter other) Description: Assigns another object to self |
dup | Signature: [const] new NetlistSpiceWriter ptr dup Description: Creates a copy of self Python specific notes: |
new | (1) Signature: [static] new NetlistSpiceWriter ptr new Description: Creates a new writer without delegate. Python specific notes: |
(2) Signature: [static] new NetlistSpiceWriter ptr new (NetlistSpiceWriterDelegate ptr delegate) Description: Creates a new writer with a delegate. Python specific notes: | |
use_net_names= | Signature: void use_net_names= (bool f) Description: Sets a value indicating whether to use net names (true) or net numbers (false). The default is to use net numbers. Python specific notes: |
use_net_names? | Signature: [const] bool use_net_names? Description: Gets a value indicating whether to use net names (true) or net numbers (false). Python specific notes: |
with_comments= | Signature: void with_comments= (bool f) Description: Sets a value indicating whether to embed comments for position etc. (true) or not (false). The default is to embed comments. Python specific notes: |
with_comments? | Signature: [const] bool with_comments? Description: Gets a value indicating whether to embed comments for position etc. (true) or not (false). Python specific notes: |