KLayout Manual: Main Index » Class Index » API reference - Class MethodAPI reference - Class MethodNotation used in Ruby API documentation Description: The interface to a method declaration Public methods
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 destroy the object Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] string docDescription: The documentation string for this method [const,iter] ArgType each_argumentDescription: Iterate over all arguments of this method [const] bool is_const?Description: True, if this method does not alter the object [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. [const] bool is_event?Description: True, if this method is an event [const] bool is_static?Description: True, if this method is static (a class method) [const] string nameDescription: The name of the class [const] ArgType ret_typeDescription: The return type of this method |