KLayout Manual: Main Index » Class Index » API reference - Class LoadLayoutOptions

API reference - Class LoadLayoutOptions

Notation used in Ruby API documentation

Description: Layout reader options

• Public constructors
• Public methods
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

This object describes various layer reader options used for loading layouts.

This class has been introduced in version 0.18.

Public constructors

Public methods

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

void _create

Description: 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 _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, 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] 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.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

void assign(const LoadLayoutOptions other)

Description: Assigns another object to self

[const] unsigned int box_mode

Description: Specifies how to treat BOX records

See gds2_box_mode= method for a description of this mode. This property has been added in version 0.18.

[const] double cif_dbu

Description: Specifies the database unit which the reader uses and produces

See cif_dbu= method for a description of this property. This property has been added in version 0.21.

Python specific notes:

The object exposes a readable attribute 'cif_dbu'. This is the getter.

void cif_dbu=(double arg1)

Description: Specifies the database unit which the reader uses and produces

This property has been added in version 0.21.

Python specific notes:

The object exposes a writable attribute 'cif_dbu'. This is the setter.

void cif_wire_mode=(unsigned int arg1)

Description: How to read 'W' objects

This property specifies how to read 'W' (wire) objects. Allowed values are 0 (as square ended paths), 1 (as flush ended paths), 2 (as round paths)

This property has been added in version 0.21.

Python specific notes:

The object exposes a writable attribute 'cif_wire_mode'. This is the setter.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void create_other_layers=(bool create)

Description: Specifies whether other layers should be created.

Python specific notes:

The object exposes a writable attribute 'create_other_layers'. This is the setter.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new LoadLayoutOptions ptr dup

Description: Creates a copy of self

[const] int dxf_circle_points

Description: Specifies the number of points used per full circle for arc interpolation

This property has been added in version 0.21.6.

Python specific notes:

The object exposes a readable attribute 'dxf_circle_points'. This is the getter.

void dxf_circle_points=(int points)

Description: Specifies the number of points used per full circle for arc interpolation

This property has been added in version 0.21.6.

Python specific notes:

The object exposes a writable attribute 'dxf_circle_points'. This is the setter.

[const] double dxf_dbu

Description: Specifies the database unit which the reader uses and produces

This property has been added in version 0.21.

Python specific notes:

The object exposes a readable attribute 'dxf_dbu'. This is the getter.

void dxf_dbu=(double dbu)

Description: Specifies the database unit which the reader uses and produces

This property has been added in version 0.21.

Python specific notes:

The object exposes a writable attribute 'dxf_dbu'. This is the setter.

[const] bool dxf_keep_other_cells

Description: If this option is true, all cells are kept, not only the top cell and it's children

This property has been added in version 0.21.15.

Python specific notes:

The object exposes a readable attribute 'dxf_keep_other_cells'. This is the getter.

void dxf_keep_other_cells=(bool value)

Description: If this option is set to true, all cells are kept, not only the top cell and it's children

This property has been added in version 0.21.15.

Python specific notes:

The object exposes a writable attribute 'dxf_keep_other_cells'. This is the setter.

[const] int dxf_polyline_mode

Description: Specifies whether closed POLYLINE and LWPOLYLINE entities with width 0 are converted to polygons.

See dxf_polyline_mode= for a description of this property.

This property has been added in version 0.21.3.

Python specific notes:

The object exposes a readable attribute 'dxf_polyline_mode'. This is the getter.

void dxf_polyline_mode=(int mode)

Description: Specifies how to treat POLYLINE/LWPOLYLINE entities.

The mode is 0 (automatic), 1 (keep lines), 2 (create polygons from closed polylines with width = 0), 3 (merge all lines with width = 0 into polygons), 4 (as 3 plus auto-close open contours).

This property has been added in version 0.21.3.

Python specific notes:

The object exposes a writable attribute 'dxf_polyline_mode'. This is the setter.

[const] bool dxf_render_texts_as_polygons

Description: If this option is true, text objects are rendered as polygons

This property has been added in version 0.21.15.

Python specific notes:

The object exposes a readable attribute 'dxf_render_texts_as_polygons'. This is the getter.

void dxf_render_texts_as_polygons=(bool value)

Description: If this option is set to true, text objects are rendered as polygons

This property has been added in version 0.21.15.

Python specific notes:

The object exposes a writable attribute 'dxf_render_texts_as_polygons'. This is the setter.

[const] double dxf_text_scaling

Description: Gets the text scaling factor (see dxf_text_scaling=)

This property has been added in version 0.21.20.

Python specific notes:

The object exposes a readable attribute 'dxf_text_scaling'. This is the getter.

void dxf_text_scaling=(double unit)

Description: Specifies the text scaling in percent of the default scaling

The default value 100, meaning that the letter pitch is roughly 92 percent of the specified text height. Decrease this value to get smaller fonts and increase it to get larger fonts.

This property has been added in version 0.21.20.

Python specific notes:

The object exposes a writable attribute 'dxf_text_scaling'. This is the setter.

[const] double dxf_unit

Description: Specifies the unit in which the DXF file is drawn

This property has been added in version 0.21.3.

Python specific notes:

The object exposes a readable attribute 'dxf_unit'. This is the getter.

void dxf_unit=(double unit)

Description: Specifies the unit in which the DXF file is drawn.

This property has been added in version 0.21.3.

Python specific notes:

The object exposes a writable attribute 'dxf_unit'. This is the setter.

[const] bool gds2_allow_big_records

Description: Specifies whether to allow big records with a length of 32768 to 65535 bytes.

See gds2_allow_big_records= method for a description of this property. This property has been added in version 0.18.

Python specific notes:

The object exposes a readable attribute 'gds2_allow_big_records'. This is the getter.

void gds2_allow_big_records=(bool arg1)

Description: Allow big records with more than 32767 bytes

Setting this property to true allows larger records by treating the record length as unsigned short, which for example allows larger polygons (~8000 points rather than ~4000 points) without using multiple XY records. For strict compatibility with the standard, this property should be set to false. The default is true.

This property has been added in version 0.18.

Python specific notes:

The object exposes a writable attribute 'gds2_allow_big_records'. This is the setter.

[const] bool gds2_allow_multi_xy_records

Description: Specifies whether to allow big polygons with multiple XY records.

See gds2_allow_multi_xy_records= method for a description of this property. This property has been added in version 0.18.

Python specific notes:

The object exposes a readable attribute 'gds2_allow_multi_xy_records'. This is the getter.

void gds2_allow_multi_xy_records=(bool arg1)

Description: Allows the use of multiple XY records in BOUNDARY elements for unlimited large polygons

Setting this property to true allows big polygons that span over multiple XY records. For strict compatibility with the standard, this property should be set to false. The default is true.

This property has been added in version 0.18.

Python specific notes:

The object exposes a writable attribute 'gds2_allow_multi_xy_records'. This is the setter.

void gds2_box_mode=(unsigned int arg1)

Description: Specify how to treat BOX records

This property specifies how BOX records are treated. Allowed values are 0 (ignore), 1 (treat as rectangles), 2 (treat as boundaries) or 3 (treat as errors). The default is 1.

This property has been added in version 0.18.

Python specific notes:

The object exposes a writable attribute 'gds2_box_mode'. This is the setter.

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[const] bool is_creating_other_layers?

Description: Tell whether other layers should be created.

[const] bool is_properties_enabled?

Description: Tell whether properties should be read.

[const] bool is_text_enabled?

Description: Tell whether text objects should be read.

LayerMap layer_map

Description: Access to the layer map member.

[static] new LoadLayoutOptions ptr new

Description: Creates a new object of this class

Python specific notes:

This method is the default initializer of the object

void properties_enabled=(bool enabled)

Description: Specifies whether properties should be read.

Python specific notes:

The object exposes a writable attribute 'properties_enabled'. This is the setter.

void select_all_layers

Description: Select all layers

This disables any layer map and enables reading of all layers while new layers will be created when required.

void set_layer_map(const LayerMap map,bool create_other_layers)

Description: Set a layer map

This sets a layer mapping for the reader. The "create_other_layers" specifies whether to create layers that are not in the mapping and automatically assign layers to them.

void text_enabled=(bool enabled)

Description: Specifies whether text objects should be read.

Python specific notes:

The object exposes a writable attribute 'text_enabled'. This is the setter.

[const] unsigned int wire_mode

Description: Specifies how to read 'W' objects

See cif_wire_mode= method for a description of this mode. This property has been added in version 0.21.