KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class Region::RectFilter

API reference - Class Region::RectFilter

Notation used in Ruby API documentation

Module: db

Description: This class represents the error filter mode on rectangles for \Region#separation and related checks.

This class is equivalent to the class Region::RectFilter

This enum has been introduced in version 0.27.

Public constructors

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

Public methods

[const]bool!=(const Region::RectFilter other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const Region::RectFilter 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 Region::RectFilter 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]Region::RectFilterFourSidesAllowedAllow errors when on all sides
[static,const]Region::RectFilterNoRectFilterSpecifies no filtering
[static,const]Region::RectFilterOneSideAllowedAllow errors on one side
[static,const]Region::RectFilterThreeSidesAllowedAllow errors when on three sides
[static,const]Region::RectFilterTwoConnectedSidesAllowedAllow errors on two sides ("L" configuration)
[static,const]Region::RectFilterTwoOppositeSidesAllowedAllow errors on two opposite sides
[static,const]Region::RectFilterTwoSidesAllowedAllow errors on two sides (not specified which)

Detailed description

!=

(1) Signature: [const] bool != (const Region::RectFilter 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 Region::RectFilter 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 Region::RectFilter other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

FourSidesAllowed

Signature: [static,const] Region::RectFilter FourSidesAllowed

Description: Allow errors when on all sides

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

NoRectFilter

Signature: [static,const] Region::RectFilter NoRectFilter

Description: Specifies no filtering

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

OneSideAllowed

Signature: [static,const] Region::RectFilter OneSideAllowed

Description: Allow errors on one side

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

ThreeSidesAllowed

Signature: [static,const] Region::RectFilter ThreeSidesAllowed

Description: Allow errors when on three sides

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

TwoConnectedSidesAllowed

Signature: [static,const] Region::RectFilter TwoConnectedSidesAllowed

Description: Allow errors on two sides ("L" configuration)

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

TwoOppositeSidesAllowed

Signature: [static,const] Region::RectFilter TwoOppositeSidesAllowed

Description: Allow errors on two opposite sides

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

TwoSidesAllowed

Signature: [static,const] Region::RectFilter TwoSidesAllowed

Description: Allow errors on two sides (not specified which)

Python specific notes:
The object exposes a readable attribute 'TwoSidesAllowed'. 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 Region::RectFilter 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 Region::RectFilter 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)'.