interactive_workspace.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_INTERACTIVE_WORKSPACE_H_
#define _ARTS_INTERACTIVE_WORKSPACE_H_

#include "agenda_class.h"
#include "workspace_ng.h"

extern void (*getaways[])(Workspace &, const MRecord &);

class InteractiveWorkspace;

class Callback {
 public:
  Callback(void (*f)(InteractiveWorkspace *))
      : callback_(f){
            // Nothing to do here.
        };

  Callback(const Callback &) = default;
  Callback(Callback &&) = default;
  Callback &operator=(const Callback &) = default;
  Callback &operator=(Callback &&) = default;
  ~Callback() = default;

  virtual void execute(InteractiveWorkspace &ws) {(*callback_)(&ws);};

 private:
  void (*callback_)(InteractiveWorkspace *);
};

class InteractiveWorkspace : private Workspace {
 public:
  InteractiveWorkspace(const Index verbosity = 1,
                       const Index agenda_verbosity = 0);

  using Workspace::is_initialized;
  using Workspace::operator[];

  static void initialize();

  const char *execute_agenda(const Agenda *a);

  const char *execute_workspace_method(long id,
                                       const ArrayOfIndex &output,
                                       const ArrayOfIndex &input);

  void set_agenda_variable(Index id, const Agenda &src);
  void set_index_variable(Index id, const Index &src);
  void set_array_of_index_variable(Index id, size_t n, const Index *src);
  void set_numeric_variable(Index id, const Numeric &src);
  void set_string_variable(Index id, const char *src);
  void set_array_of_string_variable(Index id, size_t n, const char *const *src);
  void set_vector_variable(Index id, size_t n, const Numeric *src);
  void set_matrix_variable(Index id, size_t m, size_t n, const Numeric *src);
  void set_tensor3_variable(
      Index id, size_t l, size_t m, size_t n, const Numeric *src);
  void set_tensor4_variable(
      Index id, size_t k, size_t l, size_t m, size_t n, const Numeric *src);
  void set_tensor5_variable(Index id,
                            size_t k,
                            size_t l,
                            size_t m,
                            size_t n,
                            size_t o,
                            const Numeric *src);
  void set_tensor6_variable(Index id,
                            size_t k,
                            size_t l,
                            size_t m,
                            size_t n,
                            size_t o,
                            size_t p,
                            const Numeric *src);
  void set_tensor7_variable(Index id,
                            size_t k,
                            size_t l,
                            size_t m,
                            size_t n,
                            size_t o,
                            size_t p,
                            size_t q,
                            const Numeric *src);
  void set_sparse_variable(Index id,
                           Index m,
                           Index n,
                           Index nnz,
                           const Numeric *src,
                           const int *row_indices,
                           const int *column_indices);

  void execute_callback(Index callback_id) {
    callbacks_[callback_id]->execute(*this);
  }

  static Index add_callback(Callback *cb) {
    Index id = callbacks_.size();
    callbacks_.push_back(cb);
    return id;
  }


  void initialize_variable(Index id);


  Index add_variable(Index group_id, const char *name);


  void erase_variable(Index i, Index group_id);


  void swap(Index i, Index j);

 private:
  
  void resize();

  static size_t n_anonymous_variables_;
  static std::vector<Callback *> callbacks_;
};

#endif  // _ARTS_INTERACTIVE_WORKSPACE_H_