3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
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.
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.
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.
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.
29 * For more info, check our website at http://www.gromacs.org
31 /*! \libinternal \file
33 * Declares gmx::SelectionFileOption and gmx::SelectionFileOptionInfo.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
37 * \ingroup module_selection
39 #ifndef GMX_SELECTION_SELECTIONFILEOPTION_H
40 #define GMX_SELECTION_SELECTIONFILEOPTION_H
42 #include "../options/abstractoption.h"
47 class SelectionFileOptionInfo;
48 class SelectionFileOptionStorage;
49 class SelectionOptionManager;
51 /*! \libinternal \brief
52 * Specifies a special option that provides selections from a file.
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.
60 * Public methods in this class do not throw.
63 * \ingroup module_selection
65 class SelectionFileOption : public AbstractOption
68 //! OptionInfo subclass corresponding to this option type.
69 typedef SelectionFileOptionInfo InfoType;
71 //! Initializes an option with the given name.
72 explicit SelectionFileOption(const char *name);
75 virtual AbstractOptionStoragePointer createStorage() const;
78 /*! \libinternal \brief
79 * Wrapper class for accessing and modifying selection file option information.
82 * \ingroup module_selection
84 class SelectionFileOptionInfo : public OptionInfo
88 * Creates option info object for given storage object.
92 explicit SelectionFileOptionInfo(SelectionFileOptionStorage *option);
94 //! \copydoc SelectionOptionInfo::setManager()
95 void setManager(SelectionOptionManager *manager);
98 SelectionFileOptionStorage &option();
99 const SelectionFileOptionStorage &option() const;