KLayout 0.29.8 (2024-11-26 926dac96c) [master]

KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class Macro::Interpreter

API reference - Class Macro::Interpreter

Notation used in Ruby API documentation

Module: lay

Description: Specifies the interpreter used for executing a macro

This class is equivalent to the class Macro::Interpreter

This enum has been introduced in version 0.27.5.

Public constructors

new Macro::Interpreter ptrnew(int i)Creates an enum from an integer value
new Macro::Interpreter ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const Macro::Interpreter other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const Macro::Interpreter other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const Macro::Interpreter other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum

Public static methods and constants

[static,const]Macro::InterpreterDSLInterpreterA domain-specific interpreter (DSL)
[static,const]Macro::InterpreterNoneNo specific interpreter
[static,const]Macro::InterpreterPythonThe interpreter is Python
[static,const]Macro::InterpreterRubyThe interpreter is Ruby
[static,const]Macro::InterpreterTextPlain text

Detailed description

!=

(1) Signature: [const] bool != (const Macro::Interpreter other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const Macro::Interpreter other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const Macro::Interpreter other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

DSLInterpreter

Signature: [static,const] Macro::Interpreter DSLInterpreter

Description: A domain-specific interpreter (DSL)

Python specific notes:
The object exposes a readable attribute 'DSLInterpreter'. This is the getter.

None

Signature: [static,const] Macro::Interpreter None

Description: No specific interpreter

Python specific notes:
This member is available as 'None_' in Python.
The object exposes a readable attribute 'None_'. This is the getter.

Python

Signature: [static,const] Macro::Interpreter Python

Description: The interpreter is Python

Python specific notes:
The object exposes a readable attribute 'Python'. This is the getter.

Ruby

Signature: [static,const] Macro::Interpreter Ruby

Description: The interpreter is Ruby

Python specific notes:
The object exposes a readable attribute 'Ruby'. This is the getter.

Text

Signature: [static,const] Macro::Interpreter Text

Description: Plain text

Python specific notes:
The object exposes a readable attribute 'Text'. This is the getter.

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

Python specific notes:
This method is also available as 'hash(object)'.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

new

(1) Signature: [static] new Macro::Interpreter ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new Macro::Interpreter ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object.

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

Python specific notes:
This method is also available as 'int(object)'.

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.