arts_api.h

Go to the documentation of this file.

/* Copyright (C) 2017 Simon Pfreundschuh <simon.pfreundschuh@chalmers.se>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
   USA. */

//   File description

#ifndef _ARTS_ARTS_API_H_
#define _ARTS_ARTS_API_H_

#define DLL_PUBLIC __attribute__((visibility("default")))

#include "covariance_matrix.h"
#include "interactive_workspace.h"

extern "C" {

// Structs Definitions

struct VariableStruct {
  const char *name;
  const char *description;
  long group;
};

struct VariableValueStruct {
  const void *ptr;
  bool initialized;
  long dimensions[7];
  const int *inner_ptr;
  const int *outer_ptr;
};

struct MethodStruct {
  long id;
  const char *name;
  const char *description;
  unsigned long n_out;
  const long *out;
  unsigned long n_g_out;
  const long *g_out_types;
  unsigned long n_in;
  const long *in;
  unsigned long n_g_in;
  const long *g_in_types;
};

struct VersionStruct {
  long major;
  long minor;
  long revision;
};


struct CovarianceMatrixBlockStruct {
  long indices[2];

  long position[2];

  long dimensions[2];

  const void *ptr;

  long nnz;

  const int *inner_ptr;
  const int *outer_ptr;
};

// Setup and Finalization.

DLL_PUBLIC
void include_path_push(const char *path);

DLL_PUBLIC
void include_path_pop();

DLL_PUBLIC
void data_path_push(const char *path);

DLL_PUBLIC
void data_path_pop();

DLL_PUBLIC
void initialize();

DLL_PUBLIC
void finalize();

DLL_PUBLIC
const char *get_error();

DLL_PUBLIC
void set_basename(const char *name);

// Parsing and executing agendas.

DLL_PUBLIC
Agenda *parse_agenda(const char *filename);

DLL_PUBLIC
Agenda *create_agenda(const char *name);

DLL_PUBLIC
void agenda_add_method(Agenda *a,
                       const Index id,
                       unsigned long n_args_out,
                       const long *args_out,
                       unsigned long n_args_in,
                       const long *args_in);

DLL_PUBLIC
void agenda_insert_callback(Agenda *a, void (*f)(InteractiveWorkspace *));

DLL_PUBLIC
void agenda_insert_set(InteractiveWorkspace *ws,
                       Agenda *a,
                       long id,
                       long group_id);

DLL_PUBLIC
void agenda_append(Agenda *dst, const Agenda *src);

DLL_PUBLIC
void agenda_clear(Agenda *a);

DLL_PUBLIC
const char *execute_agenda(InteractiveWorkspace *workspace, const Agenda *a);

DLL_PUBLIC
void destroy_agenda(Agenda *a);

// Creating Workspaces

DLL_PUBLIC
InteractiveWorkspace *create_workspace(const Index verbosity = 1,
                                       const Index agenda_verbosity = 0);

DLL_PUBLIC
void destroy_workspace(InteractiveWorkspace *workspace);

// Accessing WSV Group Information

DLL_PUBLIC
unsigned long get_number_of_groups();

DLL_PUBLIC
const char *get_group_name(int i);

// Accessing and Executing WSMs

DLL_PUBLIC
unsigned long get_number_of_methods();

DLL_PUBLIC
MethodStruct get_method(Index i);

DLL_PUBLIC
const char *get_method_g_in(Index i, Index j);

DLL_PUBLIC
const char *get_method_g_in_default(Index i, Index j);

DLL_PUBLIC
const char *get_g_in_nodef() {
    return NODEF;
}

DLL_PUBLIC
const char *get_method_g_out(Index i, Index j);

DLL_PUBLIC
const char *execute_workspace_method(InteractiveWorkspace *workspace,
                                     long id,
                                     unsigned long n_args_out,
                                     const long *args_out,
                                     unsigned long n_args_in,
                                     const long *args_in);

DLL_PUBLIC
const char *method_print_doc(long id);

// Accessing and Manipulating WSVs

DLL_PUBLIC
long lookup_workspace_variable(const char *s);

DLL_PUBLIC
unsigned long get_number_of_variables();

DLL_PUBLIC
VariableStruct get_variable(Index i);

DLL_PUBLIC
VariableValueStruct get_variable_value(InteractiveWorkspace *workspace,
                                       Index id,
                                       Index group_id);

DLL_PUBLIC
void * get_variable_data_pointer(InteractiveWorkspace *workspace,
                                 Index id);

DLL_PUBLIC
CovarianceMatrixBlockStruct get_covariance_matrix_block(CovarianceMatrix *m,
                                                        long block_index,
                                                        bool inverse);

DLL_PUBLIC
const char *set_variable_value(InteractiveWorkspace *workspace,
                               long id,
                               long group_id,
                               VariableValueStruct value);
DLL_PUBLIC
long add_variable(InteractiveWorkspace *workspace,
                  long group_id,
                  const char *name);

DLL_PUBLIC
void erase_variable(InteractiveWorkspace *workspace, long id, long group_id);

DLL_PUBLIC
VersionStruct get_version();
}

#endif // _ARTS_ARTS_API_