src/gromacs/options/optionsvisitor.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Implements classes in optionsvisitor.h.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_options
  37  */
  38 #include "gromacs/options/optionsvisitor.h"
  39
  40 #include "gromacs/options/abstractoptionstorage.h"
  41 #include "gromacs/options/optioninfo.h"
  42 #include "gromacs/options/options.h"
  43
  44 #include "options-impl.h"
  45
  46 namespace gmx
  47 {
  48
  49 /********************************************************************
  50  * OptionInfo
  51  */
  52
  53 OptionInfo::OptionInfo(AbstractOptionStorage *option)
  54     : _option(*option)
  55 {
  56 }
  57
  58 OptionInfo::~OptionInfo()
  59 {
  60 }
  61
  62 bool OptionInfo::isSet() const
  63 {
  64     return _option.isSet();
  65 }
  66
  67 bool OptionInfo::isHidden() const
  68 {
  69     return _option.isHidden();
  70 }
  71
  72 const std::string &OptionInfo::name() const
  73 {
  74     return _option.name();
  75 }
  76
  77 const std::string &OptionInfo::description() const
  78 {
  79     return _option.description();
  80 }
  81
  82 const char *OptionInfo::type() const
  83 {
  84     return _option.typeString();
  85 }
  86
  87 int OptionInfo::valueCount() const
  88 {
  89     return _option.valueCount();
  90 }
  91
  92 std::string OptionInfo::formatValue(int i) const
  93 {
  94     return _option.formatValue(i);
  95 }
  96
  97 std::string OptionInfo::formatValues() const
  98 {
  99     std::string result;
 100     int count = valueCount();
 101     for (int i = 0; i < count; ++i)
 102     {
 103         if (i != 0)
 104         {
 105             result.append(" ");
 106         }
 107         result.append(formatValue(i));
 108     }
 109     return result;
 110 }
 111
 112 /********************************************************************
 113  * OptionsIterator
 114  */
 115
 116 OptionsIterator::OptionsIterator(const Options &options)
 117     : _options(options)
 118 {
 119 }
 120
 121 void OptionsIterator::acceptSubSections(OptionsVisitor *visitor) const
 122 {
 123     const Options::Impl::SubSectionList &subSectionList =
 124         _options._impl->_subSections;
 125     Options::Impl::SubSectionList::const_iterator i;
 126     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 127     {
 128         visitor->visitSubSection(*(*i));
 129     }
 130 }
 131
 132 void OptionsIterator::acceptOptions(OptionsVisitor *visitor) const
 133 {
 134     const Options::Impl::OptionList &optionList =
 135         _options._impl->_options;
 136     Options::Impl::OptionList::const_iterator i;
 137     for (i = optionList.begin(); i != optionList.end(); ++i)
 138     {
 139         // This is not strictly const-correct, since optionInfo() is
 140         // not const (while the input options is), but this makes things much
 141         // simpler.
 142         visitor->visitOption((*i)->optionInfo());
 143     }
 144 }
 145
 146 /********************************************************************
 147  * OptionsModifyingIterator
 148  */
 149
 150 OptionsModifyingIterator::OptionsModifyingIterator(Options *options)
 151     : _options(*options)
 152 {
 153 }
 154
 155 void OptionsModifyingIterator::acceptSubSections(OptionsModifyingVisitor *visitor) const
 156 {
 157     const Options::Impl::SubSectionList &subSectionList =
 158         _options._impl->_subSections;
 159     Options::Impl::SubSectionList::const_iterator i;
 160     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 161     {
 162         visitor->visitSubSection(*i);
 163     }
 164 }
 165
 166 void OptionsModifyingIterator::acceptOptions(OptionsModifyingVisitor *visitor) const
 167 {
 168     const Options::Impl::OptionList &optionList =
 169         _options._impl->_options;
 170     Options::Impl::OptionList::const_iterator i;
 171     for (i = optionList.begin(); i != optionList.end(); ++i)
 172     {
 173         visitor->visitOption(&(*i)->optionInfo());
 174     }
 175 }
 176
 177 } // namespace gmx