API reference - Class TileOutputReceiverNotation used in Ruby API documentation Description: A receiver abstraction for the tiling processor.
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. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed descriptionvoid _createDescription: 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. void _destroyDescription: 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. [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. [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. void _manageDescription: 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. void _unmanageDescription: 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. void assign(const TileOutputReceiver other)Description: Assigns another object to self [virtual] void begin(unsigned long nx,unsigned long ny,const DPoint p0,double dx,double dy)Description: Initiates the delivery
This method is called before the first tile delivers it's 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. void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] new TileOutputReceiver ptr dupDescription: Creates a copy of self [virtual] void finishDescription: Indicates the end of the execution This method is called when the tiling processor has finished the last tile and script item. [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 [static] new TileOutputReceiver ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object [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. |