v_sim.NodeFinder

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (data)
	getData ()
	lookup (at, tol)
	lookupArray (ids, at, np, tol)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	GObject.Object	r
priv	v_sim.NodeFinderPrivate	r

Class Details

class v_sim.NodeFinder(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

v_sim.NodeFinderClass

An opaque structure.

New in version 3.8.

classmethod new(data)

Parameters:

data (v_sim.Data) – a v_sim.Data object.

Returns:

a pointer to the v_sim.NodeFinder it created or None otherwise.

Return type:

v_sim.NodeFinder

Creates a new v_sim.NodeFinder to look for node from coordinates.

New in version 3.8.

getData()

Returns:

the corresponding v_sim.Data the finder work on.

Return type:

v_sim.Data

Get the v_sim.Data object the self is working on.

New in version 3.8.

lookup(at, tol)

Parameters:

• at ([float]) –

• tol (float) – a float.

Returns:

the id of the closest node to at (within a maximum radius of tol). If none is found, returns -1.

Return type:

int

Giving the cartesian coordinates at, this method lookup for the closest v_sim.Node within a radius of tol.

New in version 3.8.

lookupArray(ids, at, np, tol)

Parameters:

• ids (int) – an allocated array of size np.

• at (int) – an allocated array of size 3 * np, with coordinates to be tested.

• np (int) – the number of coordinates to be tested.

• tol (float) – a radius to find the nodes in.

Apply v_sim.NodeFinder.lookup() on the array at. It’s used mainly for bindings.

New in version 3.8.