API reference - Class NetTerminalRef

Notation used in Ruby API documentation

Module: db

Description: A connection to a terminal of a device.

This object is used inside a net (see Net) to describe the connections a net makes.

This class has been added in version 0.26.

Public constructors

new NetTerminalRef ptrnewCreates a new object of this class

Public methods

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]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.
voidassign(const NetTerminalRef other)Assigns another object to self
[const]const Device ptrdeviceGets the device reference.
Device ptrdeviceGets the device reference (non-const version).
[const]const DeviceClass ptrdevice_classGets the class of the device which is addressed.
[const]new NetTerminalRef ptrdupCreates a copy of self
[const]const Net ptrnetGets the net this terminal reference is attached to.
Net ptrnetGets the net this terminal reference is attached to (non-const version).
[const]const DeviceTerminalDefinition ptrterminal_defGets the terminal definition of the terminal that is connected
[const]unsigned longterminal_idGets the ID of the terminal of the device the connection is made to.

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

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

device

(1) Signature: [const] const Device ptr device

Description: Gets the device reference.

Gets the device object that this connection is made to.

(2) Signature: Device ptr device

Description: Gets the device reference (non-const version).

Gets the device object that this connection is made to.

This constness variant has been introduced in version 0.26.8

device_class

Signature: [const] const DeviceClass ptr device_class

Description: Gets the class of the device which is addressed.

dup

Signature: [const] new NetTerminalRef ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__'

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

(1) Signature: [const] const Net ptr net

Description: Gets the net this terminal reference is attached to.

(2) Signature: Net ptr net

Description: Gets the net this terminal reference is attached to (non-const version).

This constness variant has been introduced in version 0.26.8

new

Signature: [static] new NetTerminalRef ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object

terminal_def

Signature: [const] const DeviceTerminalDefinition ptr terminal_def

Description: Gets the terminal definition of the terminal that is connected

terminal_id

Signature: [const] unsigned long terminal_id

Description: Gets the ID of the terminal of the device the connection is made to.