src/gromacs/selection/selectionfileoption.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::SelectionFileOption and gmx::SelectionFileOptionInfo.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_selection
  42  */
  43 #ifndef GMX_SELECTION_SELECTIONFILEOPTION_H
  44 #define GMX_SELECTION_SELECTIONFILEOPTION_H
  45
  46 #include "../options/abstractoption.h"
  47
  48 namespace gmx
  49 {
  50
  51 class SelectionFileOptionInfo;
  52 class SelectionFileOptionStorage;
  53 class SelectionOptionManager;
  54
  55 /*! \libinternal \brief
  56  * Specifies a special option that provides selections from a file.
  57  *
  58  * This option is used internally by the command-line framework to implement
  59  * file input for selections.  The option takes a file name, and reads it in
  60  * using SelectionOptionManager::parseRequestedFromFile().  This means that
  61  * selections from the file are assigned to selection options that have been
  62  * explicitly provided without values earlier on the command line.
  63  *
  64  * Public methods in this class do not throw.
  65  *
  66  * \inlibraryapi
  67  * \ingroup module_selection
  68  */
  69 class SelectionFileOption : public AbstractOption
  70 {
  71     public:
  72         //! OptionInfo subclass corresponding to this option type.
  73         typedef SelectionFileOptionInfo InfoType;
  74
  75         //! Initializes an option with the given name.
  76         explicit SelectionFileOption(const char *name);
  77
  78     private:
  79         virtual AbstractOptionStoragePointer createStorage() const;
  80 };
  81
  82 /*! \libinternal \brief
  83  * Wrapper class for accessing and modifying selection file option information.
  84  *
  85  * \inlibraryapi
  86  * \ingroup module_selection
  87  */
  88 class SelectionFileOptionInfo : public OptionInfo
  89 {
  90     public:
  91         /*! \brief
  92          * Creates option info object for given storage object.
  93          *
  94          * Does not throw.
  95          */
  96         explicit SelectionFileOptionInfo(SelectionFileOptionStorage *option);
  97
  98         //! \copydoc SelectionOptionInfo::setManager()
  99         void setManager(SelectionOptionManager *manager);
 100
 101     private:
 102         SelectionFileOptionStorage &option();
 103         const SelectionFileOptionStorage &option() const;
 104 };
 105
 106 } // namespace gmx
 107
 108 #endif