Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

valist.h File Reference

Contains declarations for class Valist. More...

#include "maloc/maloc.h"
#include "apbs/vhal.h"
#include "apbs/vatom.h"
#include "apbs/vparam.h"

Include dependency graph for valist.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Data Structures

struct  sValist
 Container class for list of atom objects. More...


Typedefs

typedef sValist Valist
 Declaration of the Valist class as the Valist structure.


Functions

VatomValist_getAtomList (Valist *thee)
 Get actual array of atom objects from the list.

double Valist_getCenterX (Valist *thee)
 Get x-coordinate of molecule center.

double Valist_getCenterY (Valist *thee)
 Get y-coordinate of molecule center.

double Valist_getCenterZ (Valist *thee)
 Get z-coordinate of molecule center.

int Valist_getNumberAtoms (Valist *thee)
 Get number of atoms in the list.

VatomValist_getAtom (Valist *thee, int i)
 Get pointer to particular atom in list.

unsigned long int Valist_memChk (Valist *thee)
 Get total memory allocated for this object and its members.

ValistValist_ctor ()
 Construct the atom list object.

int Valist_ctor2 (Valist *thee)
 FORTRAN stub to construct the atom list object.

void Valist_dtor (Valist **thee)
 Destroys atom list object.

void Valist_dtor2 (Valist *thee)
 FORTRAN stub to destroy atom list object.

int Valist_readPQR (Valist *thee, Vparam *param, Vio *sock)
 Fill atom list with information from a PQR file.

int Valist_readPDB (Valist *thee, Vparam *param, Vio *sock)
 Fill atom list with information from a PDB file.

int Valist_readXML (Valist *thee, Vparam *param, Vio *sock)
 Fill atom list with information from an XML file.

int Valist_getStatistics (Valist *thee)
 Load up Valist with various statistics.


Detailed Description

Contains declarations for class Valist.

Version:
Id
valist.h 1046 2007-01-02 16:58:40Z sobolevnrm
Author:
Nathan A. Baker
Attention:
 *
 * APBS -- Adaptive Poisson-Boltzmann Solver
 *
 * Nathan A. Baker (baker@biochem.wustl.edu)
 * Dept. of Biochemistry and Molecular Biophysics
 * Center for Computational Biology
 * Washington University in St. Louis
 *
 * Additional contributing authors listed in the code documentation.
 *
 * Copyright (c) 2002-2007.  Washington University in St. Louis.
 * All Rights Reserved.
 * Portions Copyright (c) 1999-2002.  The Regents of the University of
 * California.  
 * Portions Copyright (c) 1995.  Michael Holst.
 *
 * This file is part of APBS.
 *
 * APBS 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.
 *
 * APBS 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with APBS; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * Linking APBS statically or dynamically with other modules is making a
 * combined work based on APBS. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 * 
 * SPECIAL GPL EXCEPTION
 * In addition, as a special exception, the copyright holders of APBS
 * give you permission to combine the APBS program with free software
 * programs and libraries that are released under the GNU LGPL or with
 * code included in releases of ISIM, Ion Simulator Interface, PMV, PyMOL
 * SMOL, VMD, and Vision. Such combined software may be linked with APBS and 
 * redistributed together in original or modified form as mere aggregation
 * without requirement that the entire work be under the scope of the GNU 
 * General Public License. This special exception permission is also extended
 * to any software listed in the SPECIAL GPL EXCEPTION clauses by the PMG,
 * FEtk, MC, or MALOC libraries.
 * 
 * Note that people who make modified versions of APBS are not obligated
 * to grant this special exception for their modified versions; it is
 * their choice whether to do so. The GNU General Public License gives
 * permission to release a modified version without this exception; this
 * exception also makes it possible to release a modified version which
 * carries forward this exception.
 *
 * 

Generated on Thu Jul 12 11:49:57 2007 for APBS by doxygen 1.3.4