API reference - Class LoadLayoutOptions

Notation used in Ruby API documentation

Module: db

Description: Layout reader options

Sub-classes: CellConflictResolution

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

This class has been introduced in version 0.18.

Public constructors

new LoadLayoutOptions ptrnewCreates a new object of this class

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const LoadLayoutOptions other)Assigns another object to self
[const]LoadLayoutOptions::CellConflictResolutioncell_conflict_resolutionGets the cell conflict resolution mode
voidcell_conflict_resolution=(LoadLayoutOptions::CellConflictResolution mode)Sets the cell conflict resolution mode
voidcif_create_other_layers=(bool create)Specifies whether other layers shall be created
[const]boolcif_create_other_layers?Gets a value indicating whether other layers shall be created
[const]doublecif_dbuSpecifies the database unit which the reader uses and produces
voidcif_dbu=(double arg1)Specifies the database unit which the reader uses and produces
voidcif_keep_layer_names=(bool keep)Gets a value indicating whether layer names are kept
[const]boolcif_keep_layer_names?Gets a value indicating whether layer names are kept
LayerMapcif_layer_mapGets the layer map
voidcif_layer_map=(const LayerMap map)Sets the layer map
voidcif_select_all_layersSelects all layers and disables the layer map
voidcif_set_layer_map(const LayerMap map,
bool create_other_layers)
Sets the layer map
[const]unsigned intcif_wire_modeSpecifies how to read 'W' objects
voidcif_wire_mode=(unsigned int arg1)How to read 'W' objects
voidcreate_other_layers=(bool create)Specifies whether other layers shall be created
[const]boolcreate_other_layers?Gets a value indicating whether other layers shall be created
[const]new LoadLayoutOptions ptrdupCreates a copy of self
[const]doubledxf_circle_accuracyGets the accuracy of the circle approximation
voiddxf_circle_accuracy=(double accuracy)Specifies the accuracy of the circle approximation
[const]intdxf_circle_pointsGets the number of points used per full circle for arc interpolation
voiddxf_circle_points=(int points)Specifies the number of points used per full circle for arc interpolation
[const]doubledxf_contour_accuracyGets the accuracy for contour closing
voiddxf_contour_accuracy=(double accuracy)Specifies the accuracy for contour closing
voiddxf_create_other_layers=(bool create)Specifies whether other layers shall be created
[const]booldxf_create_other_layers?Gets a value indicating whether other layers shall be created
[const]doubledxf_dbuSpecifies the database unit which the reader uses and produces
voiddxf_dbu=(double dbu)Specifies the database unit which the reader uses and produces
voiddxf_keep_layer_names=(bool keep)Gets a value indicating whether layer names are kept
[const]booldxf_keep_layer_names?Gets a value indicating whether layer names are kept
voiddxf_keep_other_cells=(bool value)If this option is set to true, all cells are kept, not only the top cell and it's children
[const]booldxf_keep_other_cells?If this option is true, all cells are kept, not only the top cell and it's children
LayerMapdxf_layer_mapGets the layer map
voiddxf_layer_map=(const LayerMap map)Sets the layer map
[const]intdxf_polyline_modeSpecifies whether closed POLYLINE and LWPOLYLINE entities with width 0 are converted to polygons.
voiddxf_polyline_mode=(int mode)Specifies how to treat POLYLINE/LWPOLYLINE entities.
voiddxf_render_texts_as_polygons=(bool value)If this option is set to true, text objects are rendered as polygons
[const]booldxf_render_texts_as_polygons?If this option is true, text objects are rendered as polygons
voiddxf_select_all_layersSelects all layers and disables the layer map
voiddxf_set_layer_map(const LayerMap map,
bool create_other_layers)
Sets the layer map
[const]doubledxf_text_scalingGets the text scaling factor (see dxf_text_scaling=)
voiddxf_text_scaling=(double unit)Specifies the text scaling in percent of the default scaling
[const]doubledxf_unitSpecifies the unit in which the DXF file is drawn
voiddxf_unit=(double unit)Specifies the unit in which the DXF file is drawn.
voidgds2_allow_big_records=(bool arg1)Allows big records with more than 32767 bytes
[const]boolgds2_allow_big_records?Gets a value specifying whether to allow big records with a length of 32768 to 65535 bytes.
voidgds2_allow_multi_xy_records=(bool arg1)Allows the use of multiple XY records in BOUNDARY elements for unlimited large polygons
[const]boolgds2_allow_multi_xy_records?Gets a value specifying whether to allow big polygons with multiple XY records.
[const]unsigned intgds2_box_modeGets a value specifying how to treat BOX records
voidgds2_box_mode=(unsigned int arg1)Sets a value specifying how to treat BOX records
LayerMaplayer_mapGets the layer map
voidlayer_map=(const LayerMap map)Sets the layer map, but does not affect the "create_other_layers" flag.
LEFDEFReaderConfigurationlefdef_configGets a copy of the LEF/DEF reader configuration
voidlefdef_config=(const LEFDEFReaderConfiguration config)Sets the LEF/DEF reader configuration
voidmag_create_other_layers=(bool create)Specifies whether other layers shall be created
[const]boolmag_create_other_layers?Gets a value indicating whether other layers shall be created
[const]doublemag_dbuSpecifies the database unit which the reader uses and produces
voidmag_dbu=(double dbu)Specifies the database unit which the reader uses and produces
voidmag_keep_layer_names=(bool keep)Gets a value indicating whether layer names are kept
[const]boolmag_keep_layer_names?Gets a value indicating whether layer names are kept
[const]doublemag_lambdaGets the lambda value
voidmag_lambda=(double lambda)Specifies the lambda value to used for reading
LayerMapmag_layer_mapGets the layer map
voidmag_layer_map=(const LayerMap map)Sets the layer map
[const]string[]mag_library_pathsGets the locations where to look up libraries (in this order)
voidmag_library_paths=(string[] lib_paths)Specifies the locations where to look up libraries (in this order)
voidmag_merge=(bool merge)Sets a value indicating whether boxes are merged into polygons
[const]boolmag_merge?Gets a value indicating whether boxes are merged into polygons
voidmag_select_all_layersSelects all layers and disables the layer map
voidmag_set_layer_map(const LayerMap map,
bool create_other_layers)
Sets the layer map
voidproperties_enabled=(bool enabled)Specifies whether properties should be read
[const]boolproperties_enabled?Gets a value indicating whether properties shall be read
voidselect_all_layersSelects all layers and disables the layer map
voidset_layer_map(const LayerMap map,
bool create_other_layers)
Sets the layer map
voidtext_enabled=(bool enabled)Specifies whether text objects shall be read
[const]booltext_enabled?Gets a value indicating whether text objects shall be read

Public static methods and constants

[static,const]LoadLayoutOptions::CellConflictResolutionAddToCellAdd content to existing cell
[static,const]LoadLayoutOptions::CellConflictResolutionOverwriteCellThe old cell is overwritten entirely (including child cells which are not used otherwise)
[static,const]LoadLayoutOptions::CellConflictResolutionRenameCellThe new cell will be renamed to become unique
[static,const]LoadLayoutOptions::CellConflictResolutionSkipNewCellThe new cell is skipped entirely (including child cells which are not used otherwise)
LoadLayoutOptionsfrom_technology(string technology)Gets the reader options of a given technology

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]booldxf_keep_other_cellsUse of this method is deprecated. Use dxf_keep_other_cells? instead
[const]booldxf_render_texts_as_polygonsUse of this method is deprecated. Use dxf_render_texts_as_polygons? instead
[const]boolgds2_allow_big_recordsUse of this method is deprecated. Use gds2_allow_big_records? instead
[const]boolgds2_allow_multi_xy_recordsUse of this method is deprecated. Use gds2_allow_multi_xy_records? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead
[const]boolis_properties_enabled?Use of this method is deprecated. Use properties_enabled? instead
[const]boolis_text_enabled?Use of this method is deprecated. Use text_enabled? instead

Detailed description

AddToCell

Signature: [static,const] LoadLayoutOptions::CellConflictResolution AddToCell

Description: Add content to existing cell

This is the mode use in before version 0.27. Content of new cells is simply added to existing cells with the same name.

OverwriteCell

Signature: [static,const] LoadLayoutOptions::CellConflictResolution OverwriteCell

Description: The old cell is overwritten entirely (including child cells which are not used otherwise)

RenameCell

Signature: [static,const] LoadLayoutOptions::CellConflictResolution RenameCell

Description: The new cell will be renamed to become unique

SkipNewCell

Signature: [static,const] LoadLayoutOptions::CellConflictResolution SkipNewCell

Description: The new cell is skipped entirely (including child cells which are not used otherwise)

_create

Signature: 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.

_destroy

Signature: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: 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.

_unmanage

Signature: 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.

assign

Signature: void assign (const LoadLayoutOptions other)

Description: Assigns another object to self

cell_conflict_resolution

Signature: [const] LoadLayoutOptions::CellConflictResolution cell_conflict_resolution

Description: Gets the cell conflict resolution mode

Multiple layout files can be collected into a single Layout object by reading file after file into the Layout object. Cells with same names are considered a conflict. This mode indicates how such conflicts are resolved. See LoadLayoutOptions::CellConflictResolution for the values allowed. The default mode is LoadLayoutOptions::CellConflictResolution#AddToCell.

This option has been introduced in version 0.27.

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

cell_conflict_resolution=

Signature: void cell_conflict_resolution= (LoadLayoutOptions::CellConflictResolution mode)

Description: Sets the cell conflict resolution mode

See cell_conflict_resolution for details about this option.

This option has been introduced in version 0.27.

Python specific notes:
The object exposes a writable attribute 'cell_conflict_resolution'. This is the setter.

cif_create_other_layers=

Signature: void cif_create_other_layers= (bool create)

Description: Specifies whether other layers shall be created

create:True, if other layers will be created.

See cif_create_other_layers? for a description of this attribute.

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

Python specific notes:
The object exposes a writable attribute 'cif_create_other_layers'. This is the setter.

cif_create_other_layers?

Signature: [const] bool cif_create_other_layers?

Description: Gets a value indicating whether other layers shall be created

Returns:True, if other layers will be created.

This attribute acts together with a layer map (see cif_layer_map=). Layers not listed in this map are created as well when cif_create_other_layers? is true. Otherwise they are ignored.

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

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

cif_dbu

Signature: [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.

cif_dbu=

Signature: 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.

cif_keep_layer_names=

Signature: void cif_keep_layer_names= (bool keep)

Description: Gets a value indicating whether layer names are kept

keep:True, if layer names are to be kept.

See cif_keep_layer_names? for a description of this property.

This method has been added in version 0.25.3.

Python specific notes:
The object exposes a writable attribute 'cif_keep_layer_names'. This is the setter.

cif_keep_layer_names?

Signature: [const] bool cif_keep_layer_names?

Description: Gets a value indicating whether layer names are kept

Returns:True, if layer names are kept.

When set to true, no attempt is made to translate layer names to GDS layer/datatype numbers. If set to false (the default), a layer named "L2D15" will be translated to GDS layer 2, datatype 15.

This method has been added in version 0.25.3.

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

cif_layer_map

Signature: LayerMap cif_layer_map

Description: Gets the layer map

Returns:A reference to the layer map

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

Python note: this method has been turned into a property in version 0.26.

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

cif_layer_map=

Signature: void cif_layer_map= (const LayerMap map)

Description: Sets the layer map

map:The layer map to set.

This sets a layer mapping for the reader. Unlike cif_set_layer_map, the 'create_other_layers' flag is not changed.

This convenience method has been added in version 0.26.

Python specific notes:
The object exposes a writable attribute 'cif_layer_map'. This is the setter.

cif_select_all_layers

Signature: void cif_select_all_layers

Description: Selects all layers and disables the layer map

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

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

cif_set_layer_map

Signature: void cif_set_layer_map (const LayerMap map, bool create_other_layers)

Description: Sets the layer map

map:The layer map to set.
create_other_layers:The flag indicating whether other layers will be created as well. Set to false to read only the layers in the layer map.

This sets a layer mapping for the reader. The layer map allows selection and translation of the original layers, for example to assign layer/datatype numbers to the named layers.

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

cif_wire_mode

Signature: [const] unsigned int cif_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 and was renamed to cif_wire_mode in 0.25.

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

cif_wire_mode=

Signature: 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.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

create_other_layers=

Signature: void create_other_layers= (bool create)

Description: Specifies whether other layers shall be created

create:True, if other layers should be created.

See create_other_layers? for a description of this attribute.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

Python specific notes:
The object exposes a writable attribute 'create_other_layers'. This is the setter.

create_other_layers?

Signature: [const] bool create_other_layers?

Description: Gets a value indicating whether other layers shall be created

Returns:True, if other layers should be created.

This attribute acts together with a layer map (see layer_map=). Layers not listed in this map are created as well when create_other_layers? is true. Otherwise they are ignored.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

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

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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.

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new LoadLayoutOptions ptr dup

Description: Creates a copy of self

dxf_circle_accuracy

Signature: [const] double dxf_circle_accuracy

Description: Gets the accuracy of the circle approximation

This property has been added in version 0.24.9.

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

dxf_circle_accuracy=

Signature: void dxf_circle_accuracy= (double accuracy)

Description: Specifies the accuracy of the circle approximation

In addition to the number of points per circle, the circle accuracy can be specified. If set to a value larger than the database unit, the number of points per circle will be chosen such that the deviation from the ideal circle becomes less than this value.

The actual number of points will not become bigger than the points specified through dxf_circle_points=. The accuracy value is given in the DXF file units (see dxf_unit) which is usually micrometers.

dxf_circle_points and dxf_circle_accuracy also apply to other "round" structures such as arcs, ellipses and splines in the same sense than for circles.

This property has been added in version 0.24.9.

Python specific notes:
The object exposes a writable attribute 'dxf_circle_accuracy'. This is the setter.

dxf_circle_points

Signature: [const] int dxf_circle_points

Description: Gets 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.

dxf_circle_points=

Signature: void dxf_circle_points= (int points)

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

See also dxf_circle_accuracy for how to specify the number of points based on an approximation accuracy.

dxf_circle_points and dxf_circle_accuracy also apply to other "round" structures such as arcs, ellipses and splines in the same sense than for circles.

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.

dxf_contour_accuracy

Signature: [const] double dxf_contour_accuracy

Description: Gets the accuracy for contour closing

This property has been added in version 0.25.3.

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

dxf_contour_accuracy=

Signature: void dxf_contour_accuracy= (double accuracy)

Description: Specifies the accuracy for contour closing

When polylines need to be connected or closed, this value is used to indicate the accuracy. This is the value (in DXF units) by which points may be separated and still be considered connected. The default is 0.0 which implies exact (within one DBU) closing.

This value is effective in polyline mode 3 and 4.

This property has been added in version 0.25.3.

Python specific notes:
The object exposes a writable attribute 'dxf_contour_accuracy'. This is the setter.

dxf_create_other_layers=

Signature: void dxf_create_other_layers= (bool create)

Description: Specifies whether other layers shall be created

create:True, if other layers will be created.

See dxf_create_other_layers? for a description of this attribute.

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

Python specific notes:
The object exposes a writable attribute 'dxf_create_other_layers'. This is the setter.

dxf_create_other_layers?

Signature: [const] bool dxf_create_other_layers?

Description: Gets a value indicating whether other layers shall be created

Returns:True, if other layers will be created.

This attribute acts together with a layer map (see dxf_layer_map=). Layers not listed in this map are created as well when dxf_create_other_layers? is true. Otherwise they are ignored.

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

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

dxf_dbu

Signature: [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.

dxf_dbu=

Signature: 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.

dxf_keep_layer_names=

Signature: void dxf_keep_layer_names= (bool keep)

Description: Gets a value indicating whether layer names are kept

keep:True, if layer names are to be kept.

See cif_keep_layer_names? for a description of this property.

This method has been added in version 0.25.3.

Python specific notes:
The object exposes a writable attribute 'dxf_keep_layer_names'. This is the setter.

dxf_keep_layer_names?

Signature: [const] bool dxf_keep_layer_names?

Description: Gets a value indicating whether layer names are kept

Returns:True, if layer names are kept.

When set to true, no attempt is made to translate layer names to GDS layer/datatype numbers. If set to false (the default), a layer named "L2D15" will be translated to GDS layer 2, datatype 15.

This method has been added in version 0.25.3.

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

dxf_keep_other_cells

Signature: [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

Use of this method is deprecated. Use dxf_keep_other_cells? instead

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. The object exposes a readable attribute 'dxf_keep_other_cells'. This is the getter.

dxf_keep_other_cells=

Signature: 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.

dxf_keep_other_cells?

Signature: [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. The object exposes a readable attribute 'dxf_keep_other_cells'. This is the getter.

dxf_layer_map

Signature: LayerMap dxf_layer_map

Description: Gets the layer map

Returns:A reference to the layer map

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion. Python note: this method has been turned into a property in version 0.26.

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

dxf_layer_map=

Signature: void dxf_layer_map= (const LayerMap map)

Description: Sets the layer map

map:The layer map to set.

This sets a layer mapping for the reader. Unlike dxf_set_layer_map, the 'create_other_layers' flag is not changed.

This convenience method has been added in version 0.26.

Python specific notes:
The object exposes a writable attribute 'dxf_layer_map'. This is the setter.

dxf_polyline_mode

Signature: [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.

dxf_polyline_mode=

Signature: 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.

dxf_render_texts_as_polygons

Signature: [const] bool dxf_render_texts_as_polygons

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

Use of this method is deprecated. Use dxf_render_texts_as_polygons? instead

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. The object exposes a readable attribute 'dxf_render_texts_as_polygons'. This is the getter.

dxf_render_texts_as_polygons=

Signature: 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.

dxf_render_texts_as_polygons?

Signature: [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. The object exposes a readable attribute 'dxf_render_texts_as_polygons'. This is the getter.

dxf_select_all_layers

Signature: void dxf_select_all_layers

Description: Selects all layers and disables the layer map

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

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

dxf_set_layer_map

Signature: void dxf_set_layer_map (const LayerMap map, bool create_other_layers)

Description: Sets the layer map

map:The layer map to set.
create_other_layers:The flag indicating whether other layers will be created as well. Set to false to read only the layers in the layer map.

This sets a layer mapping for the reader. The layer map allows selection and translation of the original layers, for example to assign layer/datatype numbers to the named layers.

This method has been added in version 0.25 and replaces the respective global option in LoadLayoutOptions in a format-specific fashion.

dxf_text_scaling

Signature: [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.

dxf_text_scaling=

Signature: 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.

dxf_unit

Signature: [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.

dxf_unit=

Signature: 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.

from_technology

Signature: [static] LoadLayoutOptions from_technology (string technology)

Description: Gets the reader options of a given technology

technology:The name of the technology to apply

Returns the reader options of a specific technology. If the technology name is not valid or an empty string, the reader options of the default technology are returned.

This method has been introduced in version 0.25

gds2_allow_big_records

Signature: [const] bool gds2_allow_big_records

Description: Gets a value specifying whether to allow big records with a length of 32768 to 65535 bytes.

Use of this method is deprecated. Use gds2_allow_big_records? instead

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. The object exposes a readable attribute 'gds2_allow_big_records'. This is the getter.

gds2_allow_big_records=

Signature: void gds2_allow_big_records= (bool arg1)

Description: Allows 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.

gds2_allow_big_records?

Signature: [const] bool gds2_allow_big_records?

Description: Gets a value specifying 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. The object exposes a readable attribute 'gds2_allow_big_records'. This is the getter.

gds2_allow_multi_xy_records

Signature: [const] bool gds2_allow_multi_xy_records

Description: Gets a value specifying whether to allow big polygons with multiple XY records.

Use of this method is deprecated. Use gds2_allow_multi_xy_records? instead

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. The object exposes a readable attribute 'gds2_allow_multi_xy_records'. This is the getter.

gds2_allow_multi_xy_records=

Signature: 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.

gds2_allow_multi_xy_records?

Signature: [const] bool gds2_allow_multi_xy_records?

Description: Gets a value specifying 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. The object exposes a readable attribute 'gds2_allow_multi_xy_records'. This is the getter.

gds2_box_mode

Signature: [const] unsigned int gds2_box_mode

Description: Gets a value specifying 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.

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

gds2_box_mode=

Signature: void gds2_box_mode= (unsigned int arg1)

Description: Sets a value specifying 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.

is_const_object?

Signature: [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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

is_properties_enabled?

Signature: [const] bool is_properties_enabled?

Description: Gets a value indicating whether properties shall be read

Returns:True, if properties should be read.

Use of this method is deprecated. Use properties_enabled? instead

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

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

is_text_enabled?

Signature: [const] bool is_text_enabled?

Description: Gets a value indicating whether text objects shall be read

Returns:True, if text objects should be read.

Use of this method is deprecated. Use text_enabled? instead

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

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

layer_map

Signature: LayerMap layer_map

Description: Gets the layer map

Returns:A reference to the layer map

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration. Python note: this method has been turned into a property in version 0.26.

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

layer_map=

Signature: void layer_map= (const LayerMap map)

Description: Sets the layer map, but does not affect the "create_other_layers" flag.

map:The layer map to set.

Use create_other_layers? to enable or disable other layers not listed in the layer map.

This convenience method has been introduced with version 0.26.

Python specific notes:
The object exposes a writable attribute 'layer_map'. This is the setter.

lefdef_config

Signature: LEFDEFReaderConfiguration lefdef_config

Description: Gets a copy of the LEF/DEF reader configuration

The LEF/DEF reader configuration is wrapped in a separate object of class LEFDEFReaderConfiguration. See there for details. This method will return a copy of the reader configuration. To modify the configuration, modify the copy and set the modified configuration with lefdef_config=.

This method has been added in version 0.25.

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

lefdef_config=

Signature: void lefdef_config= (const LEFDEFReaderConfiguration config)

Description: Sets the LEF/DEF reader configuration

This method has been added in version 0.25.

Python specific notes:
The object exposes a writable attribute 'lefdef_config'. This is the setter.

mag_create_other_layers=

Signature: void mag_create_other_layers= (bool create)

Description: Specifies whether other layers shall be created

create:True, if other layers will be created.

See mag_create_other_layers? for a description of this attribute.

This method has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_create_other_layers'. This is the setter.

mag_create_other_layers?

Signature: [const] bool mag_create_other_layers?

Description: Gets a value indicating whether other layers shall be created

Returns:True, if other layers will be created.

This attribute acts together with a layer map (see mag_layer_map=). Layers not listed in this map are created as well when mag_create_other_layers? is true. Otherwise they are ignored.

This method has been added in version 0.26.2.

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

mag_dbu

Signature: [const] double mag_dbu

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

See mag_dbu= method for a description of this property.

This property has been added in version 0.26.2.

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

mag_dbu=

Signature: void mag_dbu= (double dbu)

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

The database unit is the final resolution of the produced layout. This physical resolution is usually defined by the layout system - GDS for example typically uses 1nm (mag_dbu=0.001). All geometry in the MAG file will first be scaled to mag_lambda and is then brought to the database unit.

This property has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_dbu'. This is the setter.

mag_keep_layer_names=

Signature: void mag_keep_layer_names= (bool keep)

Description: Gets a value indicating whether layer names are kept

keep:True, if layer names are to be kept.

See mag_keep_layer_names? for a description of this property.

This method has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_keep_layer_names'. This is the setter.

mag_keep_layer_names?

Signature: [const] bool mag_keep_layer_names?

Description: Gets a value indicating whether layer names are kept

Returns:True, if layer names are kept.

When set to true, no attempt is made to translate layer names to GDS layer/datatype numbers. If set to false (the default), a layer named "L2D15" will be translated to GDS layer 2, datatype 15.

This method has been added in version 0.26.2.

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

mag_lambda

Signature: [const] double mag_lambda

Description: Gets the lambda value

See mag_lambda= method for a description of this attribute.

This property has been added in version 0.26.2.

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

mag_lambda=

Signature: void mag_lambda= (double lambda)

Description: Specifies the lambda value to used for reading

The lambda value is the basic unit of the layout. Magic draws layout as multiples of this basic unit. The layout read by the MAG reader will use the database unit specified by mag_dbu, but the physical layout coordinates will be multiples of mag_lambda.

This property has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_lambda'. This is the setter.

mag_layer_map

Signature: LayerMap mag_layer_map

Description: Gets the layer map

Returns:A reference to the layer map

This method has been added in version 0.26.2.

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

mag_layer_map=

Signature: void mag_layer_map= (const LayerMap map)

Description: Sets the layer map

map:The layer map to set.

This sets a layer mapping for the reader. Unlike mag_set_layer_map, the 'create_other_layers' flag is not changed.

This method has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_layer_map'. This is the setter.

mag_library_paths

Signature: [const] string[] mag_library_paths

Description: Gets the locations where to look up libraries (in this order)

See mag_library_paths= method for a description of this attribute.

This property has been added in version 0.26.2.

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

mag_library_paths=

Signature: void mag_library_paths= (string[] lib_paths)

Description: Specifies the locations where to look up libraries (in this order)

The reader will look up library reference in these paths when it can't find them locally. Relative paths in this collection are resolved relative to the initial file's path. Expression interpolation is supported in the path strings.

This property has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_library_paths'. This is the setter.

mag_merge=

Signature: void mag_merge= (bool merge)

Description: Sets a value indicating whether boxes are merged into polygons

merge:True, if boxes and triangles will be merged into polygons.

See mag_merge? for a description of this property.

This method has been added in version 0.26.2.

Python specific notes:
The object exposes a writable attribute 'mag_merge'. This is the setter.

mag_merge?

Signature: [const] bool mag_merge?

Description: Gets a value indicating whether boxes are merged into polygons

Returns:True, if boxes are merged.

When set to true, the boxes and triangles of the Magic layout files are merged into polygons where possible.

This method has been added in version 0.26.2.

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

mag_select_all_layers

Signature: void mag_select_all_layers

Description: Selects all layers and disables the layer map

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

This method has been added in version 0.26.2.

mag_set_layer_map

Signature: void mag_set_layer_map (const LayerMap map, bool create_other_layers)

Description: Sets the layer map

map:The layer map to set.
create_other_layers:The flag indicating whether other layers will be created as well. Set to false to read only the layers in the layer map.

This sets a layer mapping for the reader. The layer map allows selection and translation of the original layers, for example to assign layer/datatype numbers to the named layers.

This method has been added in version 0.26.2.

new

Signature: [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

properties_enabled=

Signature: void properties_enabled= (bool enabled)

Description: Specifies whether properties should be read

enabled:True, if properties should be read.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

Python specific notes:
The object exposes a writable attribute 'properties_enabled'. This is the setter.

properties_enabled?

Signature: [const] bool properties_enabled?

Description: Gets a value indicating whether properties shall be read

Returns:True, if properties should be read.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

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

select_all_layers

Signature: void select_all_layers

Description: Selects all layers and disables the layer map

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

Starting with version 0.25 this method only applies to GDS2 and OASIS format. Other formats provide their own configuration.

set_layer_map

Signature: void set_layer_map (const LayerMap map, bool create_other_layers)

Description: Sets the layer map

map:The layer map to set.@param create_other_layers The flag telling whether other layer should be created as well. Set to false if just the layers in the mapping table should be read.

This sets a layer mapping for the reader. The layer map allows selection and translation of the original layers, for example to add a layer name.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

text_enabled=

Signature: void text_enabled= (bool enabled)

Description: Specifies whether text objects shall be read

enabled:True, if text objects should be read.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

Python specific notes:
The object exposes a writable attribute 'text_enabled'. This is the setter.

text_enabled?

Signature: [const] bool text_enabled?

Description: Gets a value indicating whether text objects shall be read

Returns:True, if text objects should be read.

Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration.

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