ARTS  2.3.1285(git:92a29ea9-dirty)
VariableValueStruct Struct Reference

Representation of ARTS values. More...

#include <arts_api.h>

Public Attributes

const void * ptr
 Data pointer. More...
 
bool initialized
 Initialization status. More...
 
long dimensions [7]
 Dimensions of array data. More...
 
const int * inner_ptr
 Additional array data for sparse matrices. More...
 
const int * outer_ptr
 Additional array data for sparse matrices. More...
 

Detailed Description

Representation of ARTS values.

This struct is used to transfer values of variables from inside an ARTS workspace to an outside application.

Definition at line 58 of file arts_api.h.

Member Data Documentation

◆ dimensions

long VariableValueStruct::dimensions[7]

Dimensions of array data.

Array holding the dimensions of the variables. This is required information for transferring vector, matrix or tensor data. For an n-dimensional tensor (Vector, Matrix, Tensor3, ...) the first n entries will be set to the number of elements the variable contains in the this dimension. The number of columns is stored in the last position.

Definition at line 78 of file arts_api.h.

◆ initialized

bool VariableValueStruct::initialized

Initialization status.

Bool value indicating whether the variable is initialized.

Definition at line 69 of file arts_api.h.

◆ inner_ptr

const int* VariableValueStruct::inner_ptr

Additional array data for sparse matrices.

This field is only used to return sparse matrices. In this case inner pointer will point to the array of column indices.

Definition at line 84 of file arts_api.h.

◆ outer_ptr

const int* VariableValueStruct::outer_ptr

Additional array data for sparse matrices.

This field is only used to return sparse matrices. In this case outer pointer will point to the array of column indices.

Definition at line 90 of file arts_api.h.

◆ ptr

const void* VariableValueStruct::ptr

Data pointer.

Pointer to the data of the variable or NULL, if the variable is uninitialized.

Definition at line 64 of file arts_api.h.

Referenced by set_variable_value().


The documentation for this struct was generated from the following file: