wsv_aux.h

Go to the documentation of this file.

 
#ifndef wsv_aux_h
#define wsv_aux_h
 
#include <tokval.h>
 
#include "array.h"
#include "arts.h"
#include "exceptions.h"
 
void get_wsv_group_ids(ArrayOfIndex& ids, String name);
 
bool is_agenda_group_id(const Index group_id);
 
Index get_wsv_group_id(const String& name);
 
String get_array_groups_as_string(bool basetype_is_group = false,
                                  bool return_basetype_only = false);
 
class WsvRecord {
 public:
  WsvRecord();
 
  WsvRecord(const char* name,
            const char* description,
            const String& group,
            const TokVal& val);
 
  WsvRecord(const char* name,
            const char* description,
            const Index group,
            const TokVal& val);
 
  WsvRecord(const char* name, const char* description, const String& group);
 
  WsvRecord(const char* name, const char* description, const Index group);
 
  [[nodiscard]] const String& Name() const { return mname; }
 
  [[nodiscard]] const String& Description() const { return mdescription; }
 
  [[nodiscard]] Index Group() const { return mgroup; }
 
  [[nodiscard]] bool has_defaults() const;
 
  [[nodiscard]] std::shared_ptr<void> get_copy() const;
 
  [[nodiscard]] const TokVal& default_value() const { return defval; }
  void update_default_value(ArtsType auto&& v) {defval=std::forward<decltype(v)>(v);}
 
 private:
  String mname;
 
  String mdescription;
 
  Index mgroup{-1};
 
  TokVal defval;
};
 
#endif  // wsv_aux_h