API reference - Class Region::OppositeFilter

Notation used in Ruby API documentation

Module: db

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

This class is equivalent to the class Region::OppositeFilter

This enum has been introduced in version 0.27.

Public constructors

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

Public methods

[const]bool!=(const Region::OppositeFilter other)Compares two enums for inequality
[const]bool<(const Region::OppositeFilter other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool==(const Region::OppositeFilter other)Compares two enums
[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::OppositeFilterNoOppositeFilterNo opposite filtering
[static,const]Region::OppositeFilterNotOppositeOnly errors NOT appearing on opposite sides of a figure will be reported
[static,const]Region::OppositeFilterOnlyOppositeOnly errors appearing on opposite sides of a figure will be reported

Detailed description

!=

Signature: [const] bool != (const Region::OppositeFilter other)

Description: Compares two enums for inequality

<

Signature: [const] bool < (const Region::OppositeFilter other)

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

==

Signature: [const] bool == (const Region::OppositeFilter other)

Description: Compares two enums

NoOppositeFilter

Signature: [static,const] Region::OppositeFilter NoOppositeFilter

Description: No opposite filtering

NotOpposite

Signature: [static,const] Region::OppositeFilter NotOpposite

Description: Only errors NOT appearing on opposite sides of a figure will be reported

OnlyOpposite

Signature: [static,const] Region::OppositeFilter OnlyOpposite

Description: Only errors appearing on opposite sides of a figure will be reported

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::OppositeFilter 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::OppositeFilter 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

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)'