Gromacs  2019-beta2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Attributes
gmx_ana_selparam_t Struct Reference

#include <gromacs/selection/selparam.h>

+ Collaboration diagram for gmx_ana_selparam_t:

Description

Describes a single parameter for a selection method.

Public Attributes

const char * name
 Name of the parameter. More...
 
gmx_ana_selvalue_t val
 The parameter value. More...
 
int * nvalptr
 Pointer to store the number of values. More...
 
int flags
 Flags that alter the way the parameter is parsed/handled. More...
 

Member Data Documentation

int gmx_ana_selparam_t::flags

Flags that alter the way the parameter is parsed/handled.

See selparam_flags for allowed values.

const char* gmx_ana_selparam_t::name

Name of the parameter.

int* gmx_ana_selparam_t::nvalptr

Pointer to store the number of values.

If not NULL, the number of values for the parameter is stored in the pointed value. Should be specified if SPAR_VARNUM and SPAR_DYNAMIC are both set.

Should be initialized to NULL in the definition a gmx_ana_selmethod_t and initialized in sel_datafunc().

gmx_ana_selvalue_t gmx_ana_selparam_t::val

The parameter value.

Type NO_VALUE can be used to define a boolean parameter. The number of values should be 0 for boolean parameters.

The value pointer be initialized to NULL in the definition of a gmx_ana_selmethod_t and initialized in the gmx_ana_selmethod_t::init_data call (see sel_datafunc()). However, if SPAR_VARNUM is provided and the parameter is not POS_VALUE, this field should not be initialized. Instead, sufficient memory is allocated automatically and the pointer should be stored in gmx_ana_selmethod_t::init (see sel_initfunc()).

The values cannot be accessed outside these two functions: the compiler makes a copy of the parameter structure for each instance of the method, and the original parameter array is not changed.


The documentation for this struct was generated from the following file: