API reference - Class DeviceClassBJT3Transistor

Notation used in Ruby API documentation

Module: db

Description: A device class for a bipolar transistor.

Class hierarchy: DeviceClassBJT3Transistor » DeviceClass

This class describes a bipolar transistor. Bipolar transistors have tree terminals: the collector (C), the base (B) and the emitter (E). Multi-emitter transistors are resolved in individual devices. The parameters are AE, AB and AC for the emitter, base and collector areas in square micrometers and PE, PB and PC for the emitter, base and collector perimeters in micrometers. In addition, the emitter count (NE) is given. The emitter count is 1 always for a transistor extracted initially. Upon combination of devices, the emitter counts are added, thus forming multi-emitter devices.

This class has been introduced in version 0.26.

Public methods

void_assign(const DeviceClassBJT3Transistor 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 DeviceClassBJT3Transistor 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.

Public static methods and constants

[static,const]unsigned longPARAM_ABA constant giving the parameter ID for parameter AB (base area)
[static,const]unsigned longPARAM_ACA constant giving the parameter ID for parameter AC (collector area)
[static,const]unsigned longPARAM_AEA constant giving the parameter ID for parameter AE (emitter area)
[static,const]unsigned longPARAM_NEA constant giving the parameter ID for parameter NE (emitter count)
[static,const]unsigned longPARAM_PBA constant giving the parameter ID for parameter PB (base perimeter)
[static,const]unsigned longPARAM_PCA constant giving the parameter ID for parameter PC (collector perimeter)
[static,const]unsigned longPARAM_PEA constant giving the parameter ID for parameter PE (emitter perimeter)
[static,const]unsigned longTERMINAL_BA constant giving the terminal ID for terminal B (base)
[static,const]unsigned longTERMINAL_CA constant giving the terminal ID for terminal C (collector)
[static,const]unsigned longTERMINAL_EA constant giving the terminal ID for terminal E (emitter)

Detailed description

PARAM_AB

Signature: [static,const] unsigned long PARAM_AB

Description: A constant giving the parameter ID for parameter AB (base area)

PARAM_AC

Signature: [static,const] unsigned long PARAM_AC

Description: A constant giving the parameter ID for parameter AC (collector area)

PARAM_AE

Signature: [static,const] unsigned long PARAM_AE

Description: A constant giving the parameter ID for parameter AE (emitter area)

PARAM_NE

Signature: [static,const] unsigned long PARAM_NE

Description: A constant giving the parameter ID for parameter NE (emitter count)

PARAM_PB

Signature: [static,const] unsigned long PARAM_PB

Description: A constant giving the parameter ID for parameter PB (base perimeter)

PARAM_PC

Signature: [static,const] unsigned long PARAM_PC

Description: A constant giving the parameter ID for parameter PC (collector perimeter)

PARAM_PE

Signature: [static,const] unsigned long PARAM_PE

Description: A constant giving the parameter ID for parameter PE (emitter perimeter)

TERMINAL_B

Signature: [static,const] unsigned long TERMINAL_B

Description: A constant giving the terminal ID for terminal B (base)

TERMINAL_C

Signature: [static,const] unsigned long TERMINAL_C

Description: A constant giving the terminal ID for terminal C (collector)

TERMINAL_E

Signature: [static,const] unsigned long TERMINAL_E

Description: A constant giving the terminal ID for terminal E (emitter)

_assign

Signature: void _assign (const DeviceClassBJT3Transistor 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 DeviceClassBJT3Transistor 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.