include/selvalue.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2009, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \file
  39  * \brief Declaration of \c gmx_ana_selvalue_t.
  40  *
  41  * There should be no need to use the data structures in this file directly
  42  * unless implementing a custom selection routine.
  43  */
  44 #ifndef SELVALUE_H
  45 #define SELVALUE_H
  46
  47 #include "types/simple.h"
  48
  49 #ifdef __cplusplus
  50 extern "C"
  51 {
  52 #endif
  53
  54 /** Defines the value type of a different selection objects. */
  55 typedef enum
  56 {
  57     NO_VALUE,           /**< No value; either an error condition or an gmx_boolean
  58                              parameter. */
  59     INT_VALUE,          /**< One or more integer values. */
  60     REAL_VALUE,         /**< One or more real values. */
  61     STR_VALUE,          /**< One or more string values. */
  62     POS_VALUE,          /**< One or more position values. */
  63     GROUP_VALUE         /**< One group of atoms. */
  64 } e_selvalue_t;
  65
  66 /*! \brief
  67  * Describes a value of a selection expression or of a selection method
  68  * parameter.
  69  *
  70  * Which field in the union is used depends on the \p type.
  71  */
  72 typedef struct gmx_ana_selvalue_t
  73 {
  74     /** Type of the value. */
  75     e_selvalue_t                type;
  76     /*! \brief
  77      * Number of values in the array pointed by the union.
  78      *
  79      * Note that for position and group values, it is the number of
  80      * data structures in the array, not the number of positions or
  81      * the number of atoms in the group.
  82      */
  83     int                         nr;
  84     /** Pointer to the value. */
  85     union {
  86         /*! \brief
  87          * Generic pointer for operations that do not need type information.
  88          *
  89          * Needs to be the first member to be able to use initialized arrays.
  90          */
  91         void                       *ptr;
  92         /** Integer value(s) (type \ref INT_VALUE). */
  93         int                        *i;
  94         /** Real value(s) (type \ref REAL_VALUE). */
  95         real                       *r;
  96         /** String value(s) (type \ref STR_VALUE). */
  97         char                      **s;
  98         /** Structure for the position value(s) (type \ref POS_VALUE). */
  99         struct gmx_ana_pos_t       *p;
 100         /** Group value (type \ref GROUP_VALUE). */
 101         struct gmx_ana_index_t     *g;
 102         /** Boolean value (only parameters of type \ref NO_VALUE); */
 103         gmx_bool                   *b;
 104     }                           u;
 105     /*! \brief
 106      * Number of elements allocated for the value array.
 107      */
 108     int                         nalloc;
 109 } gmx_ana_selvalue_t;
 110
 111 /** Initializes an empty selection value structure. */
 112 void
 113 _gmx_selvalue_clear(gmx_ana_selvalue_t *val);
 114 /** Reserve memory for storing selection values. */
 115 int
 116 _gmx_selvalue_reserve(gmx_ana_selvalue_t *val, int n);
 117 /** Sets the memory for storing selection values. */
 118 int
 119 _gmx_selvalue_setstore(gmx_ana_selvalue_t *val, void *ptr);
 120 /** Sets the memory for storing selection values and marks it for automatic freeing. */
 121 int
 122 _gmx_selvalue_setstore_alloc(gmx_ana_selvalue_t *val, void *ptr, int nalloc);
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif