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 /*! \cond libapi */
  54 OptionInfo::OptionInfo(AbstractOptionStorage *option)
  55     : _option(*option)
  56 {
  57 }
  58 //! \endcond
  59
  60 OptionInfo::~OptionInfo()
  61 {
  62 }
  63
  64 bool OptionInfo::isSet() const
  65 {
  66     return _option.isSet();
  67 }
  68
  69 bool OptionInfo::isHidden() const
  70 {
  71     return _option.isHidden();
  72 }
  73
  74 bool OptionInfo::isRequired() const
  75 {
  76     return _option.isRequired();
  77 }
  78
  79 const std::string &OptionInfo::name() const
  80 {
  81     return _option.name();
  82 }
  83
  84 const std::string &OptionInfo::description() const
  85 {
  86     return _option.description();
  87 }
  88
  89 const char *OptionInfo::type() const
  90 {
  91     return _option.typeString();
  92 }
  93
  94 int OptionInfo::valueCount() const
  95 {
  96     return _option.valueCount();
  97 }
  98
  99 std::string OptionInfo::formatValue(int i) const
 100 {
 101     return _option.formatValue(i);
 102 }
 103
 104 std::string OptionInfo::formatValues() const
 105 {
 106     std::string result;
 107     int count = valueCount();
 108     for (int i = 0; i < count; ++i)
 109     {
 110         if (i != 0)
 111         {
 112             result.append(" ");
 113         }
 114         result.append(formatValue(i));
 115     }
 116     return result;
 117 }
 118
 119 /********************************************************************
 120  * OptionsIterator
 121  */
 122
 123 OptionsIterator::OptionsIterator(const Options &options)
 124     : _options(options)
 125 {
 126 }
 127
 128 void OptionsIterator::acceptSubSections(OptionsVisitor *visitor) const
 129 {
 130     const Options::Impl::SubSectionList &subSectionList =
 131         _options._impl->_subSections;
 132     Options::Impl::SubSectionList::const_iterator i;
 133     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 134     {
 135         visitor->visitSubSection(*(*i));
 136     }
 137 }
 138
 139 void OptionsIterator::acceptOptions(OptionsVisitor *visitor) const
 140 {
 141     const Options::Impl::OptionList &optionList =
 142         _options._impl->_options;
 143     Options::Impl::OptionList::const_iterator i;
 144     for (i = optionList.begin(); i != optionList.end(); ++i)
 145     {
 146         // This is not strictly const-correct, since optionInfo() is
 147         // not const (while the input options is), but this makes things much
 148         // simpler.
 149         visitor->visitOption((*i)->optionInfo());
 150     }
 151 }
 152
 153 /********************************************************************
 154  * OptionsModifyingIterator
 155  */
 156
 157 OptionsModifyingIterator::OptionsModifyingIterator(Options *options)
 158     : _options(*options)
 159 {
 160 }
 161
 162 void OptionsModifyingIterator::acceptSubSections(OptionsModifyingVisitor *visitor) const
 163 {
 164     const Options::Impl::SubSectionList &subSectionList =
 165         _options._impl->_subSections;
 166     Options::Impl::SubSectionList::const_iterator i;
 167     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 168     {
 169         visitor->visitSubSection(*i);
 170     }
 171 }
 172
 173 void OptionsModifyingIterator::acceptOptions(OptionsModifyingVisitor *visitor) const
 174 {
 175     const Options::Impl::OptionList &optionList =
 176         _options._impl->_options;
 177     Options::Impl::OptionList::const_iterator i;
 178     for (i = optionList.begin(); i != optionList.end(); ++i)
 179     {
 180         visitor->visitOption(&(*i)->optionInfo());
 181     }
 182 }
 183
 184 } // namespace gmx