src/gromacs/selection/selectionoption.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 /*! \file
  32  * \brief
  33  * Declares gmx::SelectionOption.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inpublicapi
  37  * \ingroup module_selection
  38  */
  39 #ifndef GMX_SELECTION_SELECTIONOPTION_H
  40 #define GMX_SELECTION_SELECTIONOPTION_H
  41
  42 #include "../options/abstractoption.h"
  43 #include "selection.h"
  44 #include "selectionenums.h"
  45 #include "selectionoptioninfo.h"
  46
  47 namespace gmx
  48 {
  49
  50 class SelectionOptionInfo;
  51 class SelectionOptionStorage;
  52
  53 /*! \brief
  54  * Specifies an option that provides selection(s).
  55  *
  56  * Public methods in this class do not throw.
  57  *
  58  * \inpublicapi
  59  * \ingroup module_selection
  60  */
  61 class SelectionOption : public OptionTemplate<Selection, SelectionOption>
  62 {
  63     public:
  64         //! OptionInfo subclass corresponding to this option type.
  65         typedef SelectionOptionInfo InfoType;
  66
  67         //! Initializes an option with the given name.
  68         explicit SelectionOption(const char *name) : MyBase(name) { }
  69
  70         /*! \brief
  71          * Request velocity evaluation for output positions.
  72          *
  73          * Note that even with this flag set, velocities may not be available,
  74          * in which case SelectionPosition::hasVelocity() returns false.
  75          */
  76         MyClass &evaluateVelocities()
  77         { selectionFlags_.set(efSelection_EvaluateVelocities); return me(); }
  78         /*! \brief
  79          * Request force evaluation for output positions.
  80          *
  81          * Note that even with this flag set, forces may not be available,
  82          * in which case SelectionPosition::hasForce() returns false.
  83          */
  84         MyClass &evaluateForces()
  85         { selectionFlags_.set(efSelection_EvaluateForces); return me(); }
  86         /*! \brief
  87          * Only accept selections that evaluate to atom positions.
  88          *
  89          * TODO: This option is not yet implemented.
  90          */
  91         MyClass &onlyAtoms()
  92         { selectionFlags_.set(efSelection_OnlyAtoms); return me(); }
  93         /*! \brief
  94          * Only accept static selections for this option.
  95          */
  96         MyClass &onlyStatic()
  97         { selectionFlags_.set(efSelection_OnlyStatic); return me(); }
  98         /*! \brief
  99          * Handle dynamic selections for this option with position masks.
 100          *
 101          * \see Selection
 102          * \see SelectionPosition::selected()
 103          */
 104         MyClass &dynamicMask()
 105         { selectionFlags_.set(efSelection_DynamicMask); return me(); }
 106         /*! \brief
 107          * Disallow using atom coordinates as the reference positions.
 108          *
 109          * TODO: This option is not yet implemented.
 110          */
 111         MyClass &dynamicOnlyWhole()
 112         { selectionFlags_.set(efSelection_DynamicOnlyWhole); return me(); }
 113
 114     private:
 115         // Disable possibility to allow multiple occurrences, since it isn't
 116         // implemented.
 117         using MyBase::allowMultiple;
 118         // Disable default value because it is impossible to provide a
 119         // Selection object.
 120         using MyBase::defaultValue;
 121         using MyBase::defaultValueIfSet;
 122
 123         virtual AbstractOptionStoragePointer createStorage() const;
 124
 125         SelectionFlags          selectionFlags_;
 126
 127         /*! \brief
 128          * Needed to initialize SelectionOptionStorage from this class without
 129          * otherwise unnecessary accessors.
 130          */
 131         friend class SelectionOptionStorage;
 132 };
 133
 134 } // namespace gmx
 135
 136 #endif