API reference - Class EdgePairs

Notation used in Ruby API documentation

Description: EdgePairs (a collection of edge pairs)

Edge pairs are used mainly in the context of the DRC functions (width_check, space_check etc.) of Region and Edges. A single edge pair represents two edges participating in a DRC violation. In the two-layer checks (inside, overlap) The first edge represents an edge from the first layer and the second edge an edge from the second layer. For single-layer checks (width, space) the order of the edges is arbitrary.

This class has been introduced in version 0.23.

Public constructors

new EdgePairs ptrnewDefault constructor

Public methods

[const]EdgePairs+(const EdgePairs other)Returns the combined edge pair collection of self and the other one
EdgePairs+=(const EdgePairs other)Adds the edge pairs of the other edge pair collection to self
[const]const EdgePair ptr[](unsigned long n)Returns the nth edge pair
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 EdgePairs other)Assigns another object to self
[const]BoxbboxReturn the bounding box of the edge pair collection
voidclearClears the edge pair collection
voiddisable_progressDisable progress reporting
[const]new EdgePairs ptrdupCreates a copy of self
[const,iter]EdgePaireachReturns each edge pair of the edge pair collection
[const]EdgesedgesDecomposes the edge pairs into single edges
voidenable_progress(string label)Enable progress reporting
[const]RegionextentsReturns a region with the bounding boxes of the edge pairs
[const]Regionextents(int d)Returns a region with the enlarged bounding boxes of the edge pairs
[const]Regionextents(int dx,
int dy)
Returns a region with the enlarged bounding boxes of the edge pairs
[const]Edgesfirst_edgesReturns the first one of all edges
voidinsert(const Edge first,
const Edge second)
Inserts an edge pair into the collection
voidinsert(const EdgePair edge_pair)Inserts an edge pair into the collection
voidinsert(const EdgePairs edge_pairs)Inserts all edge pairs from the other edge pair collection into this edge pair collection
[const]boolis_empty?Returns true if the collection is empty
EdgePairsmove(const Vector p)Moves the edge pair collection
EdgePairsmove(int x,
int y)
Moves the edge pair collection
[const]EdgePairsmoved(const Vector p)Returns the moved edge pair collection (does not modify self)
[const]EdgePairsmoved(int x,
int y)
Returns the moved edge pair collection (does not modify self)
[const]RegionpolygonsConverts the edge pairs to polygons
[const]Regionpolygons(int e)Converts the edge pairs to polygons
[const]Edgessecond_edgesReturns the second one of all edges
[const]unsigned longsizeReturns the number of edge pairs in this collection
voidswap(EdgePairs other)Swap the contents of this collection with the contents of another collection
[const]stringto_sConverts the edge pair collection to a string
[const]stringto_s(unsigned long max_count)Converts the edge pair collection to a string
EdgePairstransform(const Trans t)Transform the edge pair collection (modifies self)
EdgePairstransform(const ICplxTrans t)Transform the edge pair collection with a complex transformation (modifies self)
[const]EdgePairstransformed(const Trans t)Transform the edge pair collection
[const]EdgePairstransformed(const ICplxTrans t)Transform the edge pair collection with a complex transformation

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]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead
EdgePairstransform_icplx(const ICplxTrans t)Use of this method is deprecated. Use transform instead
[const]EdgePairstransformed_icplx(const ICplxTrans t)Use of this method is deprecated. Use transformed instead

Detailed description

+

Signature: [const] EdgePairs + (const EdgePairs other)

Description: Returns the combined edge pair collection of self and the other one

Returns:The resulting edge pair collection

This operator adds the edge pairs of the other collection to self and returns a new combined set.

This method has been introduced in version 0.24.

+=

Signature: EdgePairs += (const EdgePairs other)

Description: Adds the edge pairs of the other edge pair collection to self

Returns:The edge pair collection after modification (self)

This operator adds the edge pairs of the other collection to self.

This method has been introduced in version 0.24.

[]

Signature: [const] const EdgePair ptr [] (unsigned long n)

Description: Returns the nth edge pair

This method returns nil if the index is out of range.

_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 EdgePairs other)

Description: Assigns another object to self

bbox

Signature: [const] Box bbox

Description: Return the bounding box of the edge pair collection

The bounding box is the box enclosing all points of all edge pairs.

clear

Signature: void clear

Description: Clears the edge pair collection

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

disable_progress

Signature: void disable_progress

Description: Disable progress reporting

Calling this method will disable progress reporting. See enable_progress.

dup

Signature: [const] new EdgePairs ptr dup

Description: Creates a copy of self

each

Signature: [const,iter] EdgePair each

Description: Returns each edge pair of the edge pair collection

Python specific notes:
This method enables iteration of the object

edges

Signature: [const] Edges edges

Description: Decomposes the edge pairs into single edges

Returns:An edge collection containing the individual edges

enable_progress

Signature: void enable_progress (string label)

Description: Enable progress reporting

After calling this method, the edge pair collection will report the progress through a progress bar while expensive operations are running. The label is a text which is put in front of the progress bar. Using a progress bar will imply a performance penalty of a few percent typically.

extents

Signature: [const] Region extents

Description: Returns a region with the bounding boxes of the edge pairs

This method will return a region consisting of the bounding boxes of the edge pairs. The boxes will not be merged, so it is possible to determine overlaps of these boxes for example.

Signature: [const] Region extents (int d)

Description: Returns a region with the enlarged bounding boxes of the edge pairs

This method will return a region consisting of the bounding boxes of the edge pairs enlarged by the given distance d. The enlargement is specified per edge, i.e the width and height will be increased by 2*d. The boxes will not be merged, so it is possible to determine overlaps of these boxes for example.

Signature: [const] Region extents (int dx,int dy)

Description: Returns a region with the enlarged bounding boxes of the edge pairs

This method will return a region consisting of the bounding boxes of the edge pairs enlarged by the given distance dx in x direction and dy in y direction. The enlargement is specified per edge, i.e the width will be increased by 2*dx. The boxes will not be merged, so it is possible to determine overlaps of these boxes for example.

first_edges

Signature: [const] Edges first_edges

Description: Returns the first one of all edges

Returns:An edge collection containing the first edges

insert

Signature: void insert (const Edge first,const Edge second)

Description: Inserts an edge pair into the collection

Signature: void insert (const EdgePair edge_pair)

Description: Inserts an edge pair into the collection

Signature: void insert (const EdgePairs edge_pairs)

Description: Inserts all edge pairs from the other edge pair collection into this edge pair collection

This method has been introduced in version 0.25.

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

is_empty?

Signature: [const] bool is_empty?

Description: Returns true if the collection is empty

move

Signature: EdgePairs move (const Vector p)

Description: Moves the edge pair collection

p:The distance to move the edge pairs.
Returns:The moved edge pairs (self).

Moves the edge pairs by the given offset and returns the moved edge pair collection. The edge pair collection is overwritten.

Starting with version 0.25 the displacement is of vector type.

Signature: EdgePairs move (int x,int y)

Description: Moves the edge pair collection

x:The x distance to move the edge pairs.
y:The y distance to move the edge pairs.
Returns:The moved edge pairs (self).

Moves the edge pairs by the given offset and returns the moved edge pairs. The edge pair collection is overwritten.

moved

Signature: [const] EdgePairs moved (const Vector p)

Description: Returns the moved edge pair collection (does not modify self)

p:The distance to move the edge pairs.
Returns:The moved edge pairs.

Moves the edge pairs by the given offset and returns the moved edge pairs. The edge pair collection is not modified.

Starting with version 0.25 the displacement is of vector type.

Signature: [const] EdgePairs moved (int x,int y)

Description: Returns the moved edge pair collection (does not modify self)

x:The x distance to move the edge pairs.
y:The y distance to move the edge pairs.
Returns:The moved edge pairs.

Moves the edge pairs by the given offset and returns the moved edge pairs. The edge pair collection is not modified.

new

Signature: [static] new EdgePairs ptr new

Description: Default constructor

This constructor creates an empty edge pair collection.

Python specific notes:
This method is the default initializer of the object

polygons

Signature: [const] Region polygons

Description: Converts the edge pairs to polygons

This method creates polygons from the edge pairs. Each polygon will be a triangle or quadrangle which connects the start and end points of the edges forming the edge pair.

Signature: [const] Region polygons (int e)

Description: Converts the edge pairs to polygons

This method creates polygons from the edge pairs. Each polygon will be a triangle or quadrangle which connects the start and end points of the edges forming the edge pair. This version allows to specify an enlargement which is applied to the edges. The length of the edges is modified by applying the enlargement and the edges are shifted by the enlargement. By specifying an enlargement it is possible to give edge pairs an area which otherwise would not have one (coincident edges, two point-like edges).

second_edges

Signature: [const] Edges second_edges

Description: Returns the second one of all edges

Returns:An edge collection containing the second edges

size

Signature: [const] unsigned long size

Description: Returns the number of edge pairs in this collection

Python specific notes:
This method is also available as 'len(object)'

swap

Signature: void swap (EdgePairs other)

Description: Swap the contents of this collection with the contents of another collection

This method is useful to avoid excessive memory allocation in some cases. For managed memory languages such as Ruby, those cases will be rare.

to_s

Signature: [const] string to_s

Description: Converts the edge pair collection to a string

The length of the output is limited to 20 edge pairs to avoid giant strings on large regions. For full output use "to_s" with a maximum count parameter.

Python specific notes:
This method is also available as 'str(object)' and 'repr(object)'

Signature: [const] string to_s (unsigned long max_count)

Description: Converts the edge pair collection to a string

This version allows specification of the maximum number of edge pairs contained in the string.

Python specific notes:
This method is also available as 'str(object)' and 'repr(object)'

transform

Signature: EdgePairs transform (const Trans t)

Description: Transform the edge pair collection (modifies self)

t:The transformation to apply.
Returns:The transformed edge pair collection.

Transforms the edge pair collection with the given transformation. This version modifies the edge pair collection and returns a reference to self.

Signature: EdgePairs transform (const ICplxTrans t)

Description: Transform the edge pair collection with a complex transformation (modifies self)

t:The transformation to apply.
Returns:The transformed edge pair collection.

Transforms the edge pair collection with the given transformation. This version modifies the edge pair collection and returns a reference to self.

transform_icplx

Signature: EdgePairs transform_icplx (const ICplxTrans t)

Description: Transform the edge pair collection with a complex transformation (modifies self)

t:The transformation to apply.
Returns:The transformed edge pair collection.

Use of this method is deprecated. Use transform instead

transformed

Signature: [const] EdgePairs transformed (const Trans t)

Description: Transform the edge pair collection

t:The transformation to apply.
Returns:The transformed edge pairs.

Transforms the edge pairs with the given transformation. Does not modify the edge pair collection but returns the transformed edge pairs.

Signature: [const] EdgePairs transformed (const ICplxTrans t)

Description: Transform the edge pair collection with a complex transformation

t:The transformation to apply.
Returns:The transformed edge pairs.

Transforms the edge pairs with the given complex transformation. Does not modify the edge pair collection but returns the transformed edge pairs.

transformed_icplx

Signature: [const] EdgePairs transformed_icplx (const ICplxTrans t)

Description: Transform the edge pair collection with a complex transformation

t:The transformation to apply.
Returns:The transformed edge pairs.

Use of this method is deprecated. Use transformed instead