src/gromacs/selection/selectionfileoption.h

   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 /*! \libinternal \file
  32  * \brief
  33  * Declares gmx::SelectionFileOption.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inlibraryapi
  37  * \ingroup module_selection
  38  */
  39 #ifndef GMX_SELECTION_SELECTIONFILEOPTION_H
  40 #define GMX_SELECTION_SELECTIONFILEOPTION_H
  41
  42 #include "../options/abstractoption.h"
  43
  44 namespace gmx
  45 {
  46
  47 /*! \libinternal \brief
  48  * Specifies a special option that provides selections from a file.
  49  *
  50  * This option is used internally by the command-line framework to implement
  51  * file input for selections.  The option takes a file name, and reads it in
  52  * using SelectionOptionManager::parseRequestedFromFile().  This means that
  53  * selections from the file are assigned to selection options that have been
  54  * explicitly provided without values earlier on the command line.
  55  *
  56  * Public methods in this class do not throw.
  57  *
  58  * \inlibraryapi
  59  * \ingroup module_selection
  60  */
  61 class SelectionFileOption : public AbstractOption
  62 {
  63     public:
  64         //! Initializes an option with the given name.
  65         explicit SelectionFileOption(const char *name);
  66
  67     private:
  68         virtual AbstractOptionStoragePointer createStorage() const;
  69 };
  70
  71 } // namespace gmx
  72
  73 #endif