Notation used in Ruby API documentation
Module: db
Description: Implements a netlist Reader for the SPICE format.
Class hierarchy: NetlistSpiceReader » NetlistReader
Use the SPICE reader like this:
reader = RBA::NetlistSpiceReader::new netlist = RBA::Netlist::new netlist.read(path, reader)
The translation of SPICE elements can be tailored by providing a NetlistSpiceReaderDelegate class. This allows translating of device parameters and mapping of some subcircuits to devices.
The following example is a delegate that turns subcircuits called HVNMOS and HVPMOS into MOS4 devices with the parameters scaled by 1.5:
class MyDelegate < RBA::NetlistSpiceReaderDelegate
# says we want to catch these subcircuits as devices
def wants_subcircuit(name)
name == "HVNMOS" || name == "HVPMOS"
end
# translate the element
def element(circuit, el, name, model, value, nets, params)
if el != "X"
# all other elements are left to the standard implementation
return super
end
if nets.size != 4
error("Subcircuit #{model} needs four nodes")
end
# provide a device class
cls = circuit.netlist.device_class_by_name(model)
if ! cls
cls = RBA::DeviceClassMOS4Transistor::new
cls.name = model
circuit.netlist.add(cls)
end
# create a device
device = circuit.create_device(cls, name)
# and configure the device
[ "S", "G", "D", "B" ].each_with_index do |t,index|
device.connect_terminal(t, nets[index])
end
params.each do |p,value|
device.set_parameter(p, value * 1.5)
end
end
end
# usage:
mydelegate = MyDelegate::new
reader = RBA::NetlistSpiceReader::new(mydelegate)
nl = RBA::Netlist::new
nl.read(input_file, reader)
A somewhat contrived example for using the delegate to translate net names is this:
class MyDelegate < RBA::NetlistSpiceReaderDelegate
# translates 'VDD' to 'VXX' and leave all other net names as is:
alias translate_net_name_org translate_net_name
def translate_net_name(n)
return n == "VDD" ? "VXX" : translate_net_name_org(n)}
end
end
This class has been introduced in version 0.26. It has been extended in version 0.27.1.
| new NetlistSpiceReader ptr | new | Creates a new reader. | |
| new NetlistSpiceReader ptr | new | (NetlistSpiceReaderDelegate ptr delegate) | Creates a new reader with a delegate. |
| [const] | NetlistSpiceReader 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] NetlistSpiceReader 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 | (1) Signature: [static] new NetlistSpiceReader ptr new Description: Creates a new reader. Python specific notes: |
(2) Signature: [static] new NetlistSpiceReader ptr new (NetlistSpiceReaderDelegate ptr delegate) Description: Creates a new reader with a delegate. Python specific notes: |