src/gromacs/options/optionflags.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  * Defines flags used in option implementation.
  34  *
  35  * Symbols in this header are considered an implementation detail, and should
  36  * not be accessed outside the module.
  37  * Because of details in the implementation, it is still installed.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  40  * \ingroup module_options
  41  */
  42 #ifndef GMX_OPTIONS_OPTIONFLAGS_H
  43 #define GMX_OPTIONS_OPTIONFLAGS_H
  44
  45 #include "../utility/flags.h"
  46
  47 namespace gmx
  48 {
  49
  50 /*! \cond libapi */
  51 /*! \libinternal \brief
  52  * Flags for options.
  53  *
  54  * These flags are not part of the public interface, even though they are in an
  55  * installed header.  They are needed in a few template class implementations.
  56  */
  57 enum OptionFlag
  58 {
  59     //! %Option has been set.
  60     efSet                 = 1<<0,
  61     //! The current value of the option is a programmatic default value.
  62     efHasDefaultValue     = 1<<1,
  63     /*! \brief
  64      * Next assignment to the option clears old values.
  65      *
  66      * This flag is set when a new option source starts, such that values
  67      * from the new source will overwrite old ones.
  68      */
  69     efClearOnNextSet      = 1<<5,
  70     //! %Option is required to be set.
  71     efRequired            = 1<<2,
  72     //! %Option can be specified multiple times.
  73     efMulti               = 1<<3,
  74     //! %Option is hidden from standard help.
  75     efHidden              = 1<<4,
  76     /*! \brief
  77      * %Option value is a vector, but a single value is also accepted.
  78      *
  79      * If only a single value is provided, the storage object should fill the
  80      * whole vector with that value.  The length of the vector must be fixed.
  81      * The default length is 3 elements.
  82      */
  83     efVector              = 1<<6,
  84     efExternalStore       = 1<<8,
  85     efExternalValueVector = 1<<10,
  86     //! %Option does not support default values.
  87     efNoDefaultValue      = 1<<7,
  88     /*! \brief
  89      * Storage object does its custom checking for minimum value count.
  90      *
  91      * If this flag is set, the class derived from OptionStorageTemplate should
  92      * implement processSetValues(), processAll(), and possible other functions
  93      * it provides such that it always fails if not enough values are provided.
  94      * This is useful to override the default check, which is done in
  95      * OptionStorageTemplate::processSet().
  96      */
  97     efDontCheckMinimumCount     = 1<<16,
  98     //efDynamic             = 1<<16,
  99     //efRanges              = 1<<17,
 100     //efEnum                = 1<<18,
 101     //efStaticEnum          = 1<<19,
 102     //efVarNum              = 1<<20,
 103     //efAtomVal             = 1<<21,
 104 };
 105
 106 //! \libinternal Holds a combination of ::OptionFlag values.
 107 typedef FlagsTemplate<OptionFlag> OptionFlags;
 108 //! \endcond
 109
 110 } // namespace gmx
 111
 112 #endif