KLayout Manual: Main Index » Class Index » API reference - Class ArgTypeAPI reference - Class ArgTypeNotation used in Ruby API documentation Description: The description of a type (argument or return value)
Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const ArgType arg1)Description: Inequality of two types [const] bool ==(const ArgType arg1)Description: Equality of two types [static] int TypeBoolDescription: [static] int TypeCharDescription: [static] int TypeDoubleDescription: [static] int TypeFloatDescription: [static] int TypeIntDescription: [static] int TypeLongDescription: [static] int TypeLongLongDescription: [static] int TypeObjectDescription: [static] int TypeObjectNewDescription: [static] int TypeQStringDescription: [static] int TypeSCharDescription: [static] int TypeShortDescription: [static] int TypeStringDescription: [static] int TypeStringCCptrDescription: [static] int TypeUCharDescription: [static] int TypeUIntDescription: [static] int TypeULongDescription: [static] int TypeULongLongDescription: [static] int TypeUShortDescription: [static] int TypeVarDescription: [static] int TypeVectorDescription: [static] int TypeVoidDescription: [const] void assign(const ArgType other)Description: Assign the contents of another object to self This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content. [const] const Class ptr clsDescription: Specifies the class for t_object.. types void 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] ArgType dupDescription: Creates a copy of self [const] const ArgType ptr innerDescription: Returns the inner ArgType object (i.e. value of a vector) Starting with version 0.22, this method replaces the is_vector method. [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_cptr?Description: True, if the type is a const pointer to the given type This property indicates that the argument is a const pointer (in C++: 'const X *'). [const] bool is_cref?Description: True, if the type is a const reference to the given type This property indicates that the argument is a const reference (in C++: 'const X &'). [const] bool is_iter?Description: (Return value only) True, if the return value is an iterator rendering the given type [const] bool is_ptr?Description: True, if the type is a non-const pointer to the given type This property indicates that the argument is a non-const pointer (in C++: 'X *'). [const] bool is_ref?Description: True, if the type is a reference to the given type Starting with version 0.22 there are more methods that describe the type of reference and is_ref? only applies to non-const reference (in C++: 'X &'). [static] ArgType newDescription: Creates a new object of this class [static] int t_boolDescription: This method is deprecated. Use method 'TypeBool' instead [static] int t_charDescription: This method is deprecated. Use method 'TypeChar' instead [static] int t_doubleDescription: This method is deprecated. Use method 'TypeDouble' instead [static] int t_floatDescription: This method is deprecated. Use method 'TypeFloat' instead [static] int t_intDescription: This method is deprecated. Use method 'TypeInt' instead [static] int t_longDescription: This method is deprecated. Use method 'TypeLong' instead [static] int t_longlongDescription: This method is deprecated. Use method 'TypeLongLong' instead [static] int t_objectDescription: This method is deprecated. Use method 'TypeObject' instead [static] int t_object_newDescription: This method is deprecated. Use method 'TypeObjectNew' instead [static] int t_qstringDescription: This method is deprecated. Use method 'TypeQString' instead [static] int t_scharDescription: This method is deprecated. Use method 'TypeSChar' instead [static] int t_shortDescription: This method is deprecated. Use method 'TypeShort' instead [static] int t_stringDescription: This method is deprecated. Use method 'TypeString' instead [static] int t_string_ccptrDescription: This method is deprecated. Use method 'TypeStringCCptr' instead [static] int t_ucharDescription: This method is deprecated. Use method 'TypeUChar' instead [static] int t_uintDescription: This method is deprecated. Use method 'TypeUInt' instead [static] int t_ulongDescription: This method is deprecated. Use method 'TypeULong' instead [static] int t_ulonglongDescription: This method is deprecated. Use method 'TypeULongLong' instead [static] int t_ushortDescription: This method is deprecated. Use method 'TypeUShort' instead [static] int t_varDescription: This method is deprecated. Use method 'TypeVar' instead [static] int t_vectorDescription: This method is deprecated. Use method 'TypeVector' instead [static] int t_voidDescription: This method is deprecated. Use method 'TypeVoid' instead [const] string to_sDescription: Convert to a string [const] int typeDescription: Return the basic type (see t_.. constants) |