diff --git a/src/db/db/gsiDeclDbRegion.cc b/src/db/db/gsiDeclDbRegion.cc index 1bd93d5d0..c70228f17 100644 --- a/src/db/db/gsiDeclDbRegion.cc +++ b/src/db/db/gsiDeclDbRegion.cc @@ -1745,18 +1745,18 @@ Class decl_Region (decl_dbShapeCollection, "db", "Region", "See \\merged_semantics= for a description of this attribute.\n" ) + method ("join_properties_on_merge=", &db::Region::set_join_properties_on_merge, gsi::arg ("f"), - "@brief Sets a flag indication whether to join properties on merge\n" + "@brief Sets a flag indicating whether to join properties on merge\n" "\n" "When this flag is set to true, properties are joined on 'merge'.\n" "That is: shapes merging into bigger shapes will have their properties joined.\n" "With the flag set to false (the default), 'merge' will not join properties and return merged\n" "shapes only if the sub-shapes have the same properties - i.e. properties form\n" - "different classes on merge.\n" + "separate shape classes on merge.\n" "\n" "This attribute has been introduced in version 0.30.3." ) + method ("join_properties_on_merge?", &db::Region::join_properties_on_merge, - "@brief Gets a flag indication whether to join properties on merge\n" + "@brief Gets a flag indicating whether to join properties on merge\n" "See \\join_properties_on_merge= for a description of this attribute.\n" "\n" "This attribute has been introduced in version 0.30.3." @@ -2428,7 +2428,7 @@ Class decl_Region (decl_dbShapeCollection, "db", "Region", "means that output is only produced if two or more polygons overlap.\n" "\n" "The 'join_properties_on_merge' argument indicates how properties should be handled: if true, " - "the properties of the constituents are joined and attached to the merged shape. If false, " + "the properties of the parts are joined and attached to the merged shape. If false, " "only shapes with the same properties are merged - i.e. different properties form shape classes " "that are merged individually.\n" "\n" @@ -2474,7 +2474,7 @@ Class decl_Region (decl_dbShapeCollection, "db", "Region", "\n" "\n" "The 'join_properties_on_merge' argument indicates how properties should be handled: if true, " - "the properties of the constituents are joined and attached to the merged shape. If false, " + "the properties of the parts are joined and attached to the merged shape. If false, " "only shapes with the same properties are merged - i.e. different properties form shape classes " "that are merged individually.\n" "\n" diff --git a/src/doc/doc/about/drc_ref_layer.xml b/src/doc/doc/about/drc_ref_layer.xml index 0a35ae1e7..b7d8cc9aa 100644 --- a/src/doc/doc/about/drc_ref_layer.xml +++ b/src/doc/doc/about/drc_ref_layer.xml @@ -1774,6 +1774,16 @@ See also select_props and re Like merged, but modifies the input and returns a reference to the new layer.

+

"merge_props" - Merges the layer and joins the properties (modifies the layer)

+ +

Usage:

+
    +
  • layer.merge_props([overlap_count])
  • +
+

+Like merged_props, but modifies the input and returns a reference to the +new layer. +

"merged" - Returns the merged layer

Usage:

@@ -1805,6 +1815,26 @@ The following images show the effect of various forms of the "merged" method:

+

"merged_props" - Merges and joins properties of the shapes

+ +

Usage:

+
    +
  • layer.merged_props([overlap_count])
  • +
+

+Returns the merged input. Unlike the plain merged method, this version +will join properties on merged shapes. Properties with the same name +will be merged by computing the maximum value of the parts. +

+For example: +Properties { "A" => 17, "C" => 2.5 } merged with { "A" => 1, "B" => "a text" } will give +{ "A" => 17, "B" => "a text", "C" => 2.5 } . +

+The plain merged method will treat shapes with different properties as +separate entities and will not merge them. +

+Currently, this method is available for polygon layers only. +

"middle" - Returns the center points of the bounding boxes of the polygons

Usage: