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

KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class LayoutToNetlist::BuildNetHierarchyMode

API reference - Class LayoutToNetlist::BuildNetHierarchyMode

Notation used in Ruby API documentation

Module: db

Description: This class represents the LayoutToNetlist::BuildNetHierarchyMode enum

This class is equivalent to the class LayoutToNetlist::BuildNetHierarchyMode

This enum is used for LayoutToNetlist#build_all_nets and LayoutToNetlist#build_net.

Public constructors

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

Public methods

[const]bool!=(const LayoutToNetlist::BuildNetHierarchyMode other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const LayoutToNetlist::BuildNetHierarchyMode 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 LayoutToNetlist::BuildNetHierarchyMode 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]LayoutToNetlist::BuildNetHierarchyModeBNH_DisconnectedThis constant tells build_net and build_all_nets to produce local nets without connections to subcircuits (used for the "hier_mode" parameter).
[static,const]LayoutToNetlist::BuildNetHierarchyModeBNH_FlattenThis constant tells build_net and build_all_nets to flatten the nets (used for the "hier_mode" parameter).
[static,const]LayoutToNetlist::BuildNetHierarchyModeBNH_SubcircuitCellsThis constant tells build_net and build_all_nets to produce a hierarchy of subcircuit cells per net (used for the "hier_mode" parameter).

Detailed description

!=

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

BNH_Disconnected

Signature: [static,const] LayoutToNetlist::BuildNetHierarchyMode BNH_Disconnected

Description: This constant tells build_net and build_all_nets to produce local nets without connections to subcircuits (used for the "hier_mode" parameter).

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

BNH_Flatten

Signature: [static,const] LayoutToNetlist::BuildNetHierarchyMode BNH_Flatten

Description: This constant tells build_net and build_all_nets to flatten the nets (used for the "hier_mode" parameter).

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

BNH_SubcircuitCells

Signature: [static,const] LayoutToNetlist::BuildNetHierarchyMode BNH_SubcircuitCells

Description: This constant tells build_net and build_all_nets to produce a hierarchy of subcircuit cells per net (used for the "hier_mode" parameter).

Python specific notes:
The object exposes a readable attribute 'BNH_SubcircuitCells'. 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 LayoutToNetlist::BuildNetHierarchyMode 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 LayoutToNetlist::BuildNetHierarchyMode 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)'.