Notation used in Ruby API documentation
Module: db
Description: Provides the results of the query
This object is used by LayoutQuery#each to deliver the results of a query in an iterative fashion. See LayoutQuery for a detailed description of the query interface.
The LayoutQueryIterator class has been introduced in version 0.25.
| new LayoutQueryIterator ptr | new | Creates a new object of this class |
| [const] | LayoutQueryIterator 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. | ||
| variant | cell | A shortcut for 'get("cell")' | ||
| variant | cell_index | A shortcut for 'get("cell_index")' | ||
| variant | data | A shortcut for 'get("data")' | ||
| variant | dtrans | A shortcut for 'get("dtrans")' | ||
| variant | get | (string name) | Gets the query property with the given name | |
| variant | initial_cell | A shortcut for 'get("initial_cell")' | ||
| variant | initial_cell_index | A shortcut for 'get("initial_cell_index")' | ||
| variant | inst | A shortcut for 'get("inst")' | ||
| variant | layer_index | A shortcut for 'get("layer_index")' | ||
| [const] | const Layout ptr | layout | Gets the layout the query acts on | |
| variant | parent_cell | A shortcut for 'get("parent_cell")' | ||
| variant | parent_cell_index | A shortcut for 'get("parent_cell_index")' | ||
| variant | path_dtrans | A shortcut for 'get("path_dtrans")' | ||
| variant | path_trans | A shortcut for 'get("path_trans")' | ||
| [const] | const LayoutQuery ptr | query | Gets the query the iterator follows on | |
| variant | shape | A shortcut for 'get("shape")' | ||
| variant | trans | A shortcut for 'get("trans")' |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] LayoutQueryIterator 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. |
cell | Signature: variant cell Description: A shortcut for 'get("cell")' |
cell_index | Signature: variant cell_index Description: A shortcut for 'get("cell_index")' |
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. |
data | Signature: variant data Description: A shortcut for 'get("data")' |
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. |
dtrans | Signature: variant dtrans Description: A shortcut for 'get("dtrans")' |
get | Signature: variant get (string name) Description: Gets the query property with the given name The query properties available can be obtained from the query object using LayoutQuery#property_names. Some shortcut methods are available. For example, the data method provides a shortcut for 'get("data")'. If a property with the given name is not available, nil will be returned. |
initial_cell | Signature: variant initial_cell Description: A shortcut for 'get("initial_cell")' |
initial_cell_index | Signature: variant initial_cell_index Description: A shortcut for 'get("initial_cell_index")' |
inst | Signature: variant inst Description: A shortcut for 'get("inst")' |
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. |
layer_index | Signature: variant layer_index Description: A shortcut for 'get("layer_index")' |
layout | Signature: [const] const Layout ptr layout Description: Gets the layout the query acts on |
new | Signature: [static] new LayoutQueryIterator ptr new Description: Creates a new object of this class Python specific notes: |
parent_cell | Signature: variant parent_cell Description: A shortcut for 'get("parent_cell")' |
parent_cell_index | Signature: variant parent_cell_index Description: A shortcut for 'get("parent_cell_index")' |
path_dtrans | Signature: variant path_dtrans Description: A shortcut for 'get("path_dtrans")' |
path_trans | Signature: variant path_trans Description: A shortcut for 'get("path_trans")' |
query | Signature: [const] const LayoutQuery ptr query Description: Gets the query the iterator follows on |
shape | Signature: variant shape Description: A shortcut for 'get("shape")' |
trans | Signature: variant trans Description: A shortcut for 'get("trans")' |