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 /********************************************************************
 105  * OptionsIterator
 106  */
 107
 108 OptionsIterator::OptionsIterator(const Options &options)
 109     : _options(options)
 110 {
 111 }
 112
 113 void OptionsIterator::acceptSubSections(OptionsVisitor *visitor) const
 114 {
 115     const Options::Impl::SubSectionList &subSectionList =
 116         _options._impl->_subSections;
 117     Options::Impl::SubSectionList::const_iterator i;
 118     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 119     {
 120         visitor->visitSubSection(*(*i));
 121     }
 122 }
 123
 124 void OptionsIterator::acceptOptions(OptionsVisitor *visitor) const
 125 {
 126     const Options::Impl::OptionList &optionList =
 127         _options._impl->_options;
 128     Options::Impl::OptionList::const_iterator i;
 129     for (i = optionList.begin(); i != optionList.end(); ++i)
 130     {
 131         // This is not strictly const-correct, since optionInfo() is
 132         // not const (while the input options is), but this makes things much
 133         // simpler.
 134         visitor->visitOption((*i)->optionInfo());
 135     }
 136 }
 137
 138 /********************************************************************
 139  * OptionsModifyingIterator
 140  */
 141
 142 OptionsModifyingIterator::OptionsModifyingIterator(Options *options)
 143     : _options(*options)
 144 {
 145 }
 146
 147 void OptionsModifyingIterator::acceptSubSections(OptionsModifyingVisitor *visitor) const
 148 {
 149     const Options::Impl::SubSectionList &subSectionList =
 150         _options._impl->_subSections;
 151     Options::Impl::SubSectionList::const_iterator i;
 152     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 153     {
 154         visitor->visitSubSection(*i);
 155     }
 156 }
 157
 158 void OptionsModifyingIterator::acceptOptions(OptionsModifyingVisitor *visitor) const
 159 {
 160     const Options::Impl::OptionList &optionList =
 161         _options._impl->_options;
 162     Options::Impl::OptionList::const_iterator i;
 163     for (i = optionList.begin(); i != optionList.end(); ++i)
 164     {
 165         visitor->visitOption(&(*i)->optionInfo());
 166     }
 167 }
 168
 169 } // namespace gmx