API reference - Class DeviceClassMOS3Transistor

Notation used in Ruby API documentation

Module: db

Description: A device class for a 3-terminal MOS transistor.

Class hierarchy: DeviceClassMOS3Transistor » DeviceClass

This class describes a MOS transistor without a bulk terminal. A device class for a MOS transistor with a bulk terminal is DeviceClassMOS4Transistor. MOS transistors are defined by their combination behavior and the basic parameters.

The parameters are L, W, AS, AD, PS and PD for the gate length and width in micrometers, source and drain area in square micrometers and the source and drain perimeter in micrometers.

The terminals are S, G and D for source, gate and drain.

MOS transistors combine in parallel mode, when both gate lengths are identical and their gates are connected (source and drain can be swapped). In this case, their widths and source and drain areas are added.

This class has been introduced in version 0.26.

Public methods

void_assign(const DeviceClassMOS3Transistor other)Assigns another object to self
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]new DeviceClassMOS3Transistor ptr_dupCreates a copy of self
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]voidjoin_split_gates(Circuit ptr circuit)Joins source/drain nets from 'split gate' transistor strings on the given circuit

Public static methods and constants

[static,const]unsigned longPARAM_ADA constant giving the parameter ID for parameter AD
[static,const]unsigned longPARAM_ASA constant giving the parameter ID for parameter AS
[static,const]unsigned longPARAM_LA constant giving the parameter ID for parameter L
[static,const]unsigned longPARAM_PDA constant giving the parameter ID for parameter PD
[static,const]unsigned longPARAM_PSA constant giving the parameter ID for parameter PS
[static,const]unsigned longPARAM_WA constant giving the parameter ID for parameter W
[static,const]unsigned longTERMINAL_DA constant giving the terminal ID for terminal D
[static,const]unsigned longTERMINAL_GA constant giving the terminal ID for terminal G
[static,const]unsigned longTERMINAL_SA constant giving the terminal ID for terminal S

Detailed description

PARAM_AD

Signature: [static,const] unsigned long PARAM_AD

Description: A constant giving the parameter ID for parameter AD

PARAM_AS

Signature: [static,const] unsigned long PARAM_AS

Description: A constant giving the parameter ID for parameter AS

PARAM_L

Signature: [static,const] unsigned long PARAM_L

Description: A constant giving the parameter ID for parameter L

PARAM_PD

Signature: [static,const] unsigned long PARAM_PD

Description: A constant giving the parameter ID for parameter PD

PARAM_PS

Signature: [static,const] unsigned long PARAM_PS

Description: A constant giving the parameter ID for parameter PS

PARAM_W

Signature: [static,const] unsigned long PARAM_W

Description: A constant giving the parameter ID for parameter W

TERMINAL_D

Signature: [static,const] unsigned long TERMINAL_D

Description: A constant giving the terminal ID for terminal D

TERMINAL_G

Signature: [static,const] unsigned long TERMINAL_G

Description: A constant giving the terminal ID for terminal G

TERMINAL_S

Signature: [static,const] unsigned long TERMINAL_S

Description: A constant giving the terminal ID for terminal S

_assign

Signature: void _assign (const DeviceClassMOS3Transistor other)

Description: Assigns another object to self

_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.

_dup

Signature: [const] new DeviceClassMOS3Transistor ptr _dup

Description: Creates a copy of self

_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.

join_split_gates

Signature: [const] void join_split_gates (Circuit ptr circuit)

Description: Joins source/drain nets from 'split gate' transistor strings on the given circuit

This method has been introduced in version 0.27.9