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 and gmx::SelectionFileOptionInfo.
  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 class SelectionFileOptionInfo;
  48 class SelectionFileOptionStorage;
  49 class SelectionOptionManager;
  50
  51 /*! \libinternal \brief
  52  * Specifies a special option that provides selections from a file.
  53  *
  54  * This option is used internally by the command-line framework to implement
  55  * file input for selections.  The option takes a file name, and reads it in
  56  * using SelectionOptionManager::parseRequestedFromFile().  This means that
  57  * selections from the file are assigned to selection options that have been
  58  * explicitly provided without values earlier on the command line.
  59  *
  60  * Public methods in this class do not throw.
  61  *
  62  * \inlibraryapi
  63  * \ingroup module_selection
  64  */
  65 class SelectionFileOption : public AbstractOption
  66 {
  67     public:
  68         //! OptionInfo subclass corresponding to this option type.
  69         typedef SelectionFileOptionInfo InfoType;
  70
  71         //! Initializes an option with the given name.
  72         explicit SelectionFileOption(const char *name);
  73
  74     private:
  75         virtual AbstractOptionStoragePointer createStorage() const;
  76 };
  77
  78 /*! \libinternal \brief
  79  * Wrapper class for accessing and modifying selection file option information.
  80  *
  81  * \inlibraryapi
  82  * \ingroup module_selection
  83  */
  84 class SelectionFileOptionInfo : public OptionInfo
  85 {
  86     public:
  87         /*! \brief
  88          * Creates option info object for given storage object.
  89          *
  90          * Does not throw.
  91          */
  92         explicit SelectionFileOptionInfo(SelectionFileOptionStorage *option);
  93
  94         //! \copydoc SelectionOptionInfo::setManager()
  95         void setManager(SelectionOptionManager *manager);
  96
  97     private:
  98         SelectionFileOptionStorage &option();
  99         const SelectionFileOptionStorage &option() const;
 100 };
 101
 102 } // namespace gmx
 103
 104 #endif