KLayout Manual: Main Index » Class Index » API reference - Class Class

API reference - Class Class

Notation used in Ruby API documentation

Description: The interface to the declarations of classes and methods

Public methods

[const]const Class ptrbaseThe base class or nil if the class does not have a base class
[const]boolcan_copy?True if the class offers assignment
[const]boolcan_destroy?True if the class offers a destroy method
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]stringdocThe documentation string for this class
[const,iter]Method ptreach_methodIterate over all methods of this class
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]stringnameThe name of the class

Public static methods and constants

[static,iter]Classeach_classIterate over all classes

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

[const]boolcan_copyUse of this method is deprecated. Use can_copy? instead
[const]boolcan_destroyUse of this method is deprecated. Use can_destroy? instead

Detailed description

[const] const Class ptr base

Description: The base class or nil if the class does not have a base class

This method has been introduced in version 0.22.

[const] bool can_copy

Description: True if the class offers assignment

This method is deprecated. Use method 'can_copy?' instead

[const] bool can_copy?

Description: True if the class offers assignment

[const] bool can_destroy

Description: True if the class offers a destroy method

This method is deprecated. Use method 'can_destroy?' instead

[const] bool can_destroy?

Description: True if the class offers a destroy method

This method has been introduced in version 0.22.

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.

void destroy

Description: 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 doc

Description: The documentation string for this class

[static,iter] Class each_class

Description: Iterate over all classes

[const,iter] Method ptr each_method

Description: Iterate over all methods of this class

[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] string name

Description: The name of the class