methods.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 methods_h
#define methods_h

#include <iosfwd>
#include "messages.h"
#include "make_array.h"
#include "matpackI.h"

#define NODEF "@@THIS_KEYWORD_HAS_NO_DEFAULT_VALUE@@"

class MdRecord;
ostream& operator<<(ostream& os, const MdRecord& mdr);

class MdRecord {
public:

  MdRecord():
    mname(        ""              ),
    mdescription( ""              ),
    mauthors(     0               ),
    moutput(      0               ),  
    mgout(        0               ),  
    mgouttype(    0               ),  
    mgoutdesc(    0               ),  
    minput(       0               ),   
    mgin(         0               ),   
    mgintype(     0               ),   
    mgindefault(  0               ),
    mgindesc(     0               ),
    mset_method(false),
    magenda_method(false),
    msupergeneric(false),
    muses_templates(false),
    mpass_workspace(true),
    mpass_wsv_names(false),
    mactual_groups("")
  {}

  // Initializing constructor. Implementation in methods_aux.cc.
  MdRecord(const char                   name[],
           const char                   description[],
           const MakeArray<String>&     authors,
           const MakeArray<String>&     output,
           const MakeArray<String>&     gout,
           const MakeArray<String>&     gouttype,
           const MakeArray<String>&     goutdesc,
           const MakeArray<String>&     input,   
           const MakeArray<String>&     gin,
           const MakeArray<String>&     gintype,   
           const MakeArray<String>&     gindefault _U_,
           const MakeArray<String>&     gindesc,
           bool                         set_method      = false,
           bool                         agenda_method   = false,
           bool                         uses_templates  = false,
           bool                         pass_workspace  = false,
           bool                         pass_wsv_names  = false
           );

  // Methods returning the lookup information:
  const String&            Name()           const { return mname; }   
  const String&            Description()    const { return mdescription; }
  const ArrayOfString&     Authors()        const { return mauthors; }   
  const ArrayOfIndex&      Out()            const { return moutput; }
  const ArrayOfString&     GOut()           const { return mgout; }
  const ArrayOfIndex&      GOutType()       const { return mgouttype; }
  const ArrayOfArrayOfIndex& GOutSpecType() const { return mgoutspectype; }
  const Array<String>&     GOutDescription()const { return mgoutdesc; }
  const ArrayOfIndex&      In()             const { return minput; }
  const ArrayOfString&     GIn()            const { return mgin; }
  const ArrayOfIndex&      GInType()        const { return mgintype; }
  const ArrayOfArrayOfIndex& GInSpecType()  const { return mginspectype; }
  const Array<String>&     GInDefault()     const { return mgindefault; }
  const Array<String>&     GInDescription() const { return mgindesc; }
  const ArrayOfIndex&      InOnly()         const { return minonly; }
  const ArrayOfIndex&      InOut()          const { return minout; }
  const ArrayOfIndex&      OutOnly()        const { return moutonly; }
  bool                     SetMethod()      const { return mset_method; }
  bool                     AgendaMethod()   const { return magenda_method; }
  bool                     Supergeneric()   const { return msupergeneric; }
  bool                     UsesTemplates()  const { return muses_templates; }
  bool                     PassWorkspace()  const { return mpass_workspace; }
  bool                     PassWsvNames()   const { return mpass_wsv_names; }
  const String&            ActualGroups()   const { return mactual_groups; }
  void                     SetPassWorkspace()  { mpass_workspace = true; }

  // Expand supergeneric method record to an actual group
  // (documentation with implementation in method_aux.cc):
  void subst_any_with_group( Index g );
  void subst_any_with_specific_group( Index g );


  ostream& PrintTemplate(ostream& os, bool show_description=true) const;


  MdRecord& operator=(const MdRecord& m){
    Verbosity verbosity;
    ArtsOut0 out0(verbosity);
    out0 << "MdRecord cannot be assigned!\n"
         << "You tried to assign: " << m << "\n";
    arts_exit ();
    return *this;
  }

  // Needed by make_auto_md_h.cc. See documentation there.
  friend void subst_any_with_group( MdRecord& mdd, Index g );

private:

  String mname;

  String mdescription;

  ArrayOfString mauthors;

  ArrayOfIndex moutput;

  ArrayOfString mgout;

  ArrayOfIndex mgouttype;

  // is not completely supergeneric but only defined for these types).
  ArrayOfArrayOfIndex mgoutspectype;

  ArrayOfString mgoutdesc;

  ArrayOfIndex minput;

  ArrayOfString mgin;

  ArrayOfIndex mgintype;

  // is not completely supergeneric but only defined for these types).
  ArrayOfArrayOfIndex mginspectype;

  ArrayOfString mgindefault;

  ArrayOfString mgindesc;

  ArrayOfIndex minonly;

  ArrayOfIndex moutonly;
  
  ArrayOfIndex minout;


  bool mset_method;


  bool magenda_method;


  bool msupergeneric;


  bool muses_templates;


  bool mpass_workspace;


  bool mpass_wsv_names;


  String mactual_groups;
};

void define_md_data_raw();

void expand_md_data_raw_to_md_data();

bool format_paragraph (String &s, const String &indent, const size_t linelen,
                       const size_t offset = 0);

void define_md_map();

void define_md_raw_map();

void get_short_wsv_description(String &s, const String &desc);

#endif  // methods_h