VisuDataAtomic

VisuDataAtomic — a class of nodes representing atomic data and providing associated loading methods.

Functions

Types and Values

Object Hierarchy

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

Implemented Interfaces

VisuDataAtomic implements VisuMaskable, VisuBoxed and VisuPointset.

Description

This class provides VisuDataLoader for atomic data representation.

Functions

visu_data_atomic_new ()

VisuDataAtomic *
visu_data_atomic_new (void);

Creates a VisuDataAtomic object.

Returns

a newly allocated VisuDataAtomic object.

Since: 3.8


visu_data_atomic_new_withFile ()

VisuDataAtomic *
visu_data_atomic_new_withFile (const gchar *file);

Creates a VisuDataAtomic object and set file to it.

Parameters

file

a filename.

 

Returns

a newly allocated VisuDataAtomic object.

Since: 3.8


visu_data_atomic_getFile ()

const gchar *
visu_data_atomic_getFile (VisuDataAtomic *data,
                          VisuDataLoader **format);

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

Parameters

data

a VisuDataAtomic object.

 

format

a location to store a VisuDataLoader object.

[out caller-allocates]

Returns

a string owned by V_Sim.

Since: 3.8


visu_data_atomic_setFile ()

void
visu_data_atomic_setFile (VisuDataAtomic *data,
                          const gchar *filename,
                          VisuDataLoader *format);

Associate filename to data . When visu_data_loadable_load() is called and format provided, this VisuDataLoader will be used only, otherwise the list of available loaders (see visu_data_atomic_class_addLoader()) will be used.

Parameters

data

a VisuDataAtomic object.

 

filename

a filename.

 

format

the associated VisuDataLoader format, if any.

[allow-none]

Since: 3.8


visu_data_atomic_getForces ()

VisuNodeValuesVector *
visu_data_atomic_getForces (VisuDataAtomic *dataObj,
                            gboolean create);

Retrieves the VisuNodeValuesVector used to store forces for dataObj , create it depending on create if not exists.

Parameters

dataObj

a VisuDataAtomic object.

 

create

a boolean.

 

Returns

a VisuNodeValuesVector object, owned by V_Sim.

[transfer none]

Since: 3.8


visu_data_atomic_class_addLoader ()

void
visu_data_atomic_class_addLoader (VisuDataLoader *loader);

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

Parameters

loader

a VisuDataLoader object.

[transfer full]

Since: 3.8


visu_data_atomic_class_getLoaders ()

GList *
visu_data_atomic_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_atomic_class_getFileDescription ()

const gchar *
visu_data_atomic_class_getFileDescription
                               (void);

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

Returns

a string owned by V_Sim.

Since: 3.8


visu_data_atomic_class_finalize ()

void
visu_data_atomic_class_finalize (void);

Empty the list of known loaders.

Since: 3.8

Types and Values

struct VisuDataAtomic

struct VisuDataAtomic;

Structure used to define VisuDataAtomic objects.

Since: 3.8


struct VisuDataAtomicClass

struct VisuDataAtomicClass {
  VisuDataLoadableClass parent;
};

A short way to identify _VisuDataAtomicClass structure.

Members

VisuDataLoadableClass parent;

the parent class.