VisuDataSpin

VisuDataSpin — a class of nodes representing spin data and providing associated loading methods.

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuNodeArray
            ╰── VisuData
                ╰── VisuDataLoadable
                    ╰── VisuDataAtomic
                        ╰── VisuDataSpin

Implemented Interfaces

VisuDataSpin implements VisuMaskable, VisuBoxed and VisuPointset.

Description

This class provides VisuDataLoader for spin data representation.

Functions

visu_data_spin_new ()

VisuDataSpin *
visu_data_spin_new (void);

Creates a VisuDataSpin object.

Returns

a newly allocated VisuDataSpin object.

Since: 3.8


visu_data_spin_new_withFiles ()

VisuDataSpin *
visu_data_spin_new_withFiles (const gchar *atomic,
                              const gchar *spin);

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

Parameters

atomic

a filename.

 

spin

a filename.

 

Returns

a newly allocated VisuDataSpin object.

Since: 3.8


visu_data_spin_getFile ()

const gchar *
visu_data_spin_getFile (VisuDataSpin *data,
                        VisuDataLoader **format);

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.

Parameters

data

a VisuDataSpin object.

 

format

a location to store the format.

[out caller-allocates]

Returns

a filename.

Since: 3.8


visu_data_spin_setFile ()

void
visu_data_spin_setFile (VisuDataSpin *data,
                        const gchar *filename,
                        VisuDataLoader *format);

Set the spin source for data and possibly provide a VisuDataLoader for this file.

Parameters

data

a VisuDataSpin object.

 

filename

a filename.

 

format

a possible VisuDataLoader format.

[allow-none]

Since: 3.8


visu_data_spin_class_addLoader ()

void
visu_data_spin_class_addLoader (VisuDataLoader *loader);

Add loader to the list of VisuDataLoader to be used when visu_data_loadable_load() is called.

Parameters

loader

a VisuDataSpin object.

[transfer full]

Since: 3.8


visu_data_spin_class_getLoaders ()

GList *
visu_data_spin_class_getLoaders (void);

Returns a list of available VisuDataLoader.

Returns

a list of VisuDataLoader owned by V_Sim.

[transfer none][element-type VisuDataLoader]

Since: 3.8


visu_data_spin_class_getFileDescription ()

const gchar *
visu_data_spin_class_getFileDescription
                               (void);

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

Returns

a string owned by V_Sim.

Since: 3.8


visu_data_spin_setAt ()

void
visu_data_spin_setAt (VisuDataSpin *dataObj,
                      const VisuNode *node,
                      const gfloat vals[3]);

Store vals as the spin representation for node in dataObj .

Parameters

dataObj

a VisuDataSpin object.

 

node

a VisuNode object.

 

vals

a vector in cartesian coordinates.

[array fixed-size=3]

Since: 3.8


visu_data_spin_setAtSpherical ()

void
visu_data_spin_setAtSpherical (VisuDataSpin *dataObj,
                               const VisuNode *node,
                               const gfloat vals[3]);

Store vals as the spin representation for node in dataObj .

Parameters

dataObj

a VisuDataSpin object.

 

node

a VisuNode object.

 

vals

a vector in spherical coordinates.

[array fixed-size=3]

Since: 3.8


visu_data_spin_getMaxModulus ()

gfloat
visu_data_spin_getMaxModulus (const VisuDataSpin *dataObj,
                              guint iElement);

Inquires the max spin modulous from dataObj for the given VisuElement represented by iElement .

Parameters

dataObj

a VisuDataSpin object.

 

iElement

an integer.

 

Returns

a positive float.

Since: 3.8


visu_data_spin_get ()

const VisuNodeValuesVector *
visu_data_spin_get (const VisuDataSpin *dataObj);

Retrieve the VisuNodeValuesVector object stroing the spin components per VisuNode.

Parameters

dataObj

a VisuDataSpin object.

 

Returns

the VisuNodeValuesVector storing the spi components of dataObj .

[transfer none]

Since: 3.8


visu_data_spin_class_finalize ()

void
visu_data_spin_class_finalize (void);

Empty the list of known loaders.

Since: 3.8

Types and Values

struct VisuDataSpin

struct VisuDataSpin;

Structure used to define VisuDataSpin objects.

Since: 3.8


struct VisuDataSpinClass

struct VisuDataSpinClass {
  VisuDataAtomicClass parent;
};

A short way to identify _VisuDataSpinClass structure.

Members

VisuDataAtomicClass parent;

the parent class.