v_sim.DataAtomic¶

Subclasses:: v_sim.DataSpin

Methods¶

Inherited:: v_sim.DataLoadable (11), v_sim.Data (27), v_sim.NodeArray (61), GObject.Object (37), v_sim.Maskable (3), v_sim.Boxed (2), v_sim.Pointset (9), v_sim.Dumpable (1)
Structs:: v_sim.DataAtomicClass (4), GObject.ObjectClass (5)

class	`addLoader` (loader)
class	`finalize` ()
class	`getFileDescription` ()
class	`getLoaders` ()
class	`new` (file, format)
	`getFile` ()
	`getForces` (create)
	`loadAt` (filename, iSet, cancel)

Virtual Methods¶

Inherited:: v_sim.DataLoadable (2), v_sim.NodeArray (2), GObject.Object (7), v_sim.Maskable (1), v_sim.Boxed (1), v_sim.Pointset (5), v_sim.Dumpable (1)

Properties¶

Inherited:: v_sim.DataLoadable (6), v_sim.Data (2), v_sim.NodeArray (3), v_sim.Boxed (2), v_sim.Pointset (4)

Name	Type	Flags	Short Description
`atomic-filename`	`str`	r/w/co	source filename
`atomic-format`	`v_sim.DataLoader`	r/w/co	source format

Signals¶

Inherited:: v_sim.Data (2), v_sim.NodeArray (5), GObject.Object (1), v_sim.Maskable (1), v_sim.Boxed (2)

Fields¶

Inherited:: v_sim.Data (2), v_sim.NodeArray (5), GObject.Object (1), v_sim.Maskable (1), v_sim.Boxed (2)

Name	Type	Access	Description
parent	`v_sim.DataLoadable`	r

Class Details¶

class v_sim.DataAtomic(**kwargs)¶

Bases:: v_sim.DataLoadable, v_sim.Dumpable
Abstract:: No
Structure:: v_sim.DataAtomicClass

Structure used to define v_sim.DataAtomic objects.

New in version 3.8.

classmethod addLoader(loader)¶

Parameters:: loader (v_sim.DataLoader) – a v_sim.DataLoader object.

Add loader to the list of v_sim.DataLoader to be used when v_sim.DataLoadable.load() is called.

New in version 3.8.

classmethod finalize()¶: Empty the list of known loaders.

New in version 3.8.

classmethod getFileDescription()¶

Returns:: a string owned by V_Sim.
Return type:: str

Returns a translated string describing what is files loaded by v_sim.DataAtomic objects.

New in version 3.8.

classmethod getLoaders()¶

Returns:: a list of v_sim.DataLoader owned by V_Sim.
Return type:: [v_sim.DataLoader]

Returns a list of available v_sim.DataLoader.

New in version 3.8.

classmethod new(file, format)¶

Parameters:

file (str) – a filename.
format (v_sim.DataLoader or None) – a v_sim.DataLoader format, if known.

Returns:

a newly allocated v_sim.DataAtomic object.

Return type:

v_sim.DataAtomic

Creates a v_sim.DataAtomic object and set file to it.

New in version 3.8.

getFile()¶

Returns:

a string owned by V_Sim.

format:: a location to store a v_sim.DataLoader object.

Return type:

(str, format: v_sim.DataLoader)

Returns the file defined in self and its associated format, if any.

New in version 3.8.

getForces(create)¶

Parameters:: create (bool) – a boolean.
Returns:: a v_sim.NodeValuesVector object, owned by V_Sim.
Return type:: v_sim.NodeValuesVector

Retrieves the v_sim.NodeValuesVector used to store forces for self, create it depending on create if not exists.

New in version 3.8.

loadAt(filename, iSet, cancel)¶

Parameters:

filename (str) – a filename.
iSet (int) – an id.
cancel (Gio.Cancellable or None) – a Gio.Cancellable object.

Raises:

GLib.Error

Returns:

True on success.

Return type:

bool

Specific routine to load an atomic file that is not stored in the location declared at construction. This is only used for archive plug-in.

New in version 3.8.

Property Details¶

v_sim.DataAtomic.props.atomic_filename¶

Name:: atomic-filename
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

source filename

v_sim.DataAtomic.props.atomic_format¶

Name:: atomic-format
Type:: v_sim.DataLoader
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

source format