Notation used in Ruby API documentation
Module: db
Description: A receiver abstraction for the tiling processor.
Class hierarchy: TileOutputReceiver
The tiling processor (TilingProcessor) is a framework for executing sequences of operations on tiles of a layout or multiple layouts. The TileOutputReceiver class is used to specify an output channel for the tiling processor. See TilingProcessor#output for more details.
This class has been introduced in version 0.23.
new TileOutputReceiver ptr | new | Creates a new object of this class |
void | _assign | (const TileOutputReceiver other) | Assigns another object to self | |
[const] | TileOutputReceiver 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] | new TileOutputReceiver ptr | _dup | Creates a copy of self | |
[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. | ||
void | assign | (const TileOutputReceiver other) | Assigns another object to self | |
[virtual] | void | begin | (unsigned long nx, unsigned long ny, const DPoint p0, double dx, double dy, const DBox frame) | Initiates the delivery |
[const] | new TileOutputReceiver ptr | dup | Creates a copy of self | |
[virtual] | void | finish | (bool success) | Indicates the end of the execution |
[const] | TilingProcessor ptr | processor | Gets the processor the receiver is attached to | |
[virtual] | void | put | (unsigned long ix, unsigned long iy, const Box tile, variant obj, double dbu, bool clip) | Delivers data for one tile |
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 |
_assign | Signature: void _assign (const TileOutputReceiver other) Description: Assigns another object to self | ||||||||||||
_const_cast | Signature: [const] TileOutputReceiver 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. | ||||||||||||
_dup | Signature: [const] new TileOutputReceiver 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. | ||||||||||||
assign | Signature: void assign (const TileOutputReceiver other) Description: Assigns another object to self | ||||||||||||
begin | Signature: [virtual] void begin (unsigned long nx, unsigned long ny, const DPoint p0, double dx, double dy, const DBox frame) Description: Initiates the delivery
This method is called before the first tile delivers its data. The tile's coordinates will be p0+(ix*dx,iy*dy)..p0+((ix+1)*dx,(iy+1)*dy) where ix=0..nx-1, iy=0..ny-1. All coordinates are given in micron. If tiles are not used, nx and ny are 0. The frame parameter has been added in version 0.25. | ||||||||||||
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. | ||||||||||||
dup | Signature: [const] new TileOutputReceiver ptr dup Description: Creates a copy of self Python specific notes: | ||||||||||||
finish | Signature: [virtual] void finish (bool success) Description: Indicates the end of the execution This method is called when the tiling processor has finished the last tile and script item. The success flag is set to true, if every tile has finished successfully. Otherwise, this value is false. The success flag has been added in version 0.25. | ||||||||||||
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. | ||||||||||||
new | Signature: [static] new TileOutputReceiver ptr new Description: Creates a new object of this class Python specific notes: | ||||||||||||
processor | Signature: [const] TilingProcessor ptr processor Description: Gets the processor the receiver is attached to This attribute is set before begin and can be nil if the receiver is not attached to a processor. This method has been introduced in version 0.25. | ||||||||||||
put | Signature: [virtual] void put (unsigned long ix, unsigned long iy, const Box tile, variant obj, double dbu, bool clip) Description: Delivers data for one tile
When the script's "_output" function is called, the data will be delivered through this method. "obj" is the data passed as the second argument to _output. The interpretation of the object remains subject to the implementation. The obj and clip parameters are taken from the _output method call inside the script. If clip is set to true, this usually means that output shall be clipped to the tile. |