v_sim.ScalarFieldMethod¶

Subclasses:: None

Methods¶

Inherited:: v_sim.FileFormat (19), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`getAll` ()
class	`new` (descr, patterns, method, priority)
	`load` (filename, options, cancel, callback, *user_data)
	`loadSync` (filename, options, cancel)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: v_sim.FileFormat (4)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.FileFormat`	r
priority	`int`	r

Class Details¶

class v_sim.ScalarFieldMethod(**kwargs)¶

Bases:: v_sim.FileFormat
Abstract:: No
Structure:: v_sim.ScalarFieldMethodClass

An opaque structure.

classmethod getAll()¶

Returns:: returns a list of V_Sim owned v_sim.ScalarFieldMethod objects.
Return type:: [v_sim.ScalarFieldMethod]

This routine gives access to all the registered load method for scamlar fields.

classmethod new(descr, patterns, method, priority)¶

Parameters:

descr (str) – the name of the method ;
patterns ([str]) – a None terminated list of strings ;
method (v_sim.ScalarFieldMethodLoadFunc) – a v_sim.ScalarFieldMethodLoadFunc method ;
priority (int) – a priority value (the lower value, the higher priority).

Returns:

a newly create method to load scalar fields.

Return type:

v_sim.ScalarFieldMethod

This routine is used to add a new method to load scalar field. The priority uses the scale of the GLib (GLib.PRIORITY_DEFAULT is 0, GLib.PRIORITY_LOW is 300 for instance).

load(filename, options, cancel, callback, *user_data)¶

Parameters:

filename (str) – a path ;
options ({object: object} or None) – some key / value options.
cancel (Gio.Cancellable or None) – a Gio.Cancellable object.
callback (Gio.AsyncReadyCallback or None) – a method to call on load finished.
user_data (object or None) – some user data.

Returns:

a list of v_sim.ScalarField on success.

Return type:

[v_sim.ScalarField]

Call the load routine of the given scalar field file format self.

New in version 3.7.

loadSync(filename, options, cancel)¶

Parameters:

filename (str) – a path ;
options ({object: object} or None) – some key / value options.
cancel (Gio.Cancellable or None) – a Gio.Cancellable object.

Raises:

GLib.Error

Returns:

a list of v_sim.ScalarField on success.

Return type:

[v_sim.ScalarField]

Same as v_sim.ScalarFieldMethod.load(), but blocking variant.

New in version 3.8.