v_sim.DataSpin¶

Subclasses:: None

Methods¶

Inherited:: v_sim.DataAtomic (8), v_sim.DataLoadable (11), v_sim.Data (24), v_sim.NodeArray (55), GObject.Object (37), v_sim.Maskable (3), v_sim.Boxed (2), v_sim.Pointset (9)
Structs:: v_sim.DataSpinClass (4), v_sim.DataAtomicClass (4), GObject.ObjectClass (5)

class	`addLoader` (loader)
class	`finalize` ()
class	`getFileDescription` ()
class	`getLoaders` ()
class	`new` (atomic, spin, atomicFormat, spinFormat)
	`get` ()
	`getFile` ()
	`getMaxModulus` (iElement)
	`setAt` (node, vals)
	`setAtSpherical` (node, vals)

Virtual Methods¶

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

Properties¶

Inherited:: v_sim.DataAtomic (2), 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
`spin-filename`	`str`	r/w/co	source filename
`spin-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 (1)

Fields¶

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

Name	Type	Access	Description
parent	`v_sim.DataAtomic`	r

Class Details¶

class v_sim.DataSpin(**kwargs)¶

Bases:: v_sim.DataAtomic
Abstract:: No
Structure:: v_sim.DataSpinClass

Structure used to define v_sim.DataSpin objects.

New in version 3.8.

classmethod addLoader(loader)¶

Parameters:: loader (v_sim.DataLoader) – a v_sim.DataSpin 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.DataSpin 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(atomic, spin, atomicFormat, spinFormat)¶

Parameters:

atomic (str) – a filename.
spin (str) – a filename.
atomicFormat (v_sim.DataLoader or None) – a v_sim.DataLoader format, if known.
spinFormat (v_sim.DataLoader or None) – a v_sim.DataLoader format, if known.

Returns:

a newly allocated v_sim.DataSpin object.

Return type:

v_sim.DataSpin

Creates a v_sim.DataSpin object and set atomic as its atomic file source and file for the spin source.

New in version 3.8.

get()¶

Returns:: the v_sim.NodeValuesVector storing the spi components of self.
Return type:: v_sim.NodeValuesVector

Retrieve the v_sim.NodeValuesVector object stroing the spin components per v_sim.Node.

New in version 3.8.

getFile()¶

Returns:

a filename.

format:: a location to store the format.

Return type:

(str, format: v_sim.DataLoader)

Retrieve the spin filename. Optionally provides also the format of this file. If the file has been parsed this is the detected format. If not, this is the supposed format, as proposed by user.

New in version 3.8.

getMaxModulus(iElement)¶

Parameters:: iElement (int) – an integer.
Returns:: a positive float.
Return type:: float

Inquires the max spin modulous from self for the given v_sim.Element represented by iElement.

New in version 3.8.

setAt(node, vals)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
vals ([float]) – a vector in cartesian coordinates.

Store vals as the spin representation for node in self.

New in version 3.8.

setAtSpherical(node, vals)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
vals ([float]) – a vector in spherical coordinates.

Store vals as the spin representation for node in self.

New in version 3.8.

Property Details¶

v_sim.DataSpin.props.spin_filename¶

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

source filename

v_sim.DataSpin.props.spin_format¶

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

source format