wsv_aux.h

Go to the documentation of this file.

/* Copyright (C) 2000-2012 Stefan Buehler <sbuehler@ltu.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, 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. */

#ifndef wsv_aux_h
#define wsv_aux_h

#include "arts.h"
#include "array.h"
#include "exceptions.h"


void get_wsv_group_ids(ArrayOfIndex& ids, String name);

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() : mname(),
                mdescription(),
                mgroup(-1),
                mimplicit(false)
  { /* Nothing to do here */ }

  WsvRecord(const char    name[],
            const char    description[],
            const String& group,
            const bool    implicit = false)
    : mname(name),
      mdescription(description),
      mgroup(-1),
      mimplicit(implicit)
  {
    // Map the group names to groups' indexes
    mgroup = get_wsv_group_id(group);
    if (mgroup == -1)
      {
        ostringstream os;

        os << "Unknown WSV Group " << group << " WSV " << mname;
        throw runtime_error( os.str() );
      }
  }

  WsvRecord(const char  name[],
            const char  description[],
            const Index group,
            const bool  implicit = false)
    : mname(name),
      mdescription(description),
      mgroup(group),
      mimplicit(implicit)
  {
    // Nothing to do here
  }
  const String&  Name()        const { return mname;        }   
  const String&  Description() const { return mdescription; }
  Index   Group()       const { return mgroup;       }
  bool    Implicit()    const { return mimplicit;       }
private:
  String mname;
  String mdescription;
  Index mgroup;
  bool mimplicit;
};


ostream& operator<<(ostream& os, const WsvRecord& wr);

#endif   // wsv_aux_h