Sort all includes in src/gromacs

[alexxy/gromacs.git] / src / gromacs / selection / selectionenums.h

diff --git a/src/gromacs/selection/selectionenums.h b/src/gromacs/selection/selectionenums.h
index cdbd201b0cb6190c9745348a57fd63adbbd682a2..2523ea8876d6e0479984ef1251be6663d54eae38 100644 (file)
--- a/src/gromacs/selection/selectionenums.h
+++ b/src/gromacs/selection/selectionenums.h
@@ -1,44 +1,48 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 2010,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
  *
- *                 G   R   O   M   A   C   S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
  *
- *          GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
  *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
 /*! \file
  * \brief
  * Declares common types used in selections.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_selection
  */
 #ifndef GMX_SELECTION_SELECTIONENUMS_H
 #define GMX_SELECTION_SELECTIONENUMS_H
 
-#include "../utility/flags.h"
+#include "gromacs/utility/flags.h"
 
 /*! \brief
  * Defines the type of covered fraction.
@@ -54,6 +58,7 @@ typedef enum
 namespace gmx
 {
 
+/*! \cond internal */
 /*! \brief
  * Flags for options.
  *
@@ -62,19 +67,21 @@ namespace gmx
  */
 enum SelectionFlag
 {
-    efOnlyStatic        = 1<<0,
-    efOnlyAtoms         = 1<<1,
+    efSelection_OnlyStatic              = 1<<0,
+    efSelection_OnlyAtoms               = 1<<1,
     //! Whether ::POS_MASKONLY should be used for output position evaluation.
-    efDynamicMask       = 1<<2,
-    efDynamicOnlyWhole  = 1<<3,
+    efSelection_DynamicMask             = 1<<2,
+    //! If set, unconditionally empty selections result in compilation errors.
+    efSelection_DisallowEmpty           = 1<<3,
     //! Whether velocities of output positions should be evaluated.
-    efEvaluateVelocities        = 1<<5,
+    efSelection_EvaluateVelocities      = 1<<5,
     //! Whether forces on output positions should be evaluated.
-    efEvaluateForces            = 1<<6,
+    efSelection_EvaluateForces          = 1<<6,
 };
 
 //! Holds a collection of ::SelectionFlag values.
 typedef FlagsTemplate<SelectionFlag> SelectionFlags;
+//! \endcond
 
 }