v_sim.DataLoader¶

Subclasses:: None

Methods¶

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

class	`ascii_getStatic` ()
class	`d3_getStatic` ()
class	`new` (descr, patterns, restricted, func, priority, *data)
class	`xyz_getStatic` ()
class	`yaml_getStatic` ()
	`comparePriority` (b)
	`load` (data, type, iSet, cancel)
	`setStatus` (status)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: v_sim.FileFormat (3)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.FileFormat`	r

Class Details¶

class v_sim.DataLoader(**kwargs)¶

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

An opaque structure.

classmethod ascii_getStatic()¶

Returns:: a v_sim.DataLoader owned by V_Sim.
Return type:: v_sim.DataLoader

Retrieve the instance of the atomic loader used to parse ASCII files.

New in version 3.8.

classmethod d3_getStatic()¶

Returns:: a v_sim.DataLoader owned by V_Sim.
Return type:: v_sim.DataLoader

Retrieve the instance of the atomic loader used to parse d3 files.

New in version 3.8.

classmethod new(descr, patterns, restricted, func, priority, *data)¶

Parameters:

descr (str) – a string describing the object, translated and in UTF8.
patterns ([str]) – the patterns used to identify files of this type.
restricted (bool) – a boolean.
func (v_sim.DataLoaderFunc) – a loading method.
priority (int) – a integer.
data (object or None) – some data.

Returns:

a newly created v_sim.DataLoader object.

Return type:

v_sim.DataLoader

Creates a new v_sim.DataLoader with the given description.

New in version 3.8.

classmethod xyz_getStatic()¶

Returns:: a v_sim.DataLoader owned by V_Sim.
Return type:: v_sim.DataLoader

Retrieve the instance of the atomic loader used to parse XYZ files.

New in version 3.8.

classmethod yaml_getStatic()¶

Returns:: a v_sim.DataLoader owned by V_Sim.
Return type:: v_sim.DataLoader

Retrieve the instance of the atomic loader used to parse YAML files.

New in version 3.8.

comparePriority(b)¶

Parameters:: b (v_sim.DataLoader) – a v_sim.DataLoader object.
Returns:: -1 if self is at a lower priority than b, +1 otherwise and 0 in case of equality.
Return type:: int

Compare the priority of self and b.

New in version 3.8.

load(data, type, iSet, cancel)¶

Parameters:

data (v_sim.DataLoadable) – a v_sim.DataLoadable object to be populated.
type (int) – a file type.
iSet (int) – an integer.
cancel (Gio.Cancellable or None) – a cancellation object.

Raises:

GLib.Error

Returns:

True if filename is of a format handled by self.

Return type:

bool

Try to load filename as a file format corresponding to self. error is not set if filename is not of this format, simply False is returned.

New in version 3.8.

setStatus(status)¶

Parameters:: status (str) – a string.

Change the current status of self. This can be used to notify changes when v_sim.DataLoader.load() is taking long time.

New in version 3.8.