Chemical Data Processing Library C++ API - Version 1.4.0
Grid/ControlParameterFunctions.hpp
Go to the documentation of this file.
1 /*
2  * ControlParameterFunctions.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_GRID_CONTROLPARAMETERFUNCTIONS_HPP
30 #define CDPL_GRID_CONTROLPARAMETERFUNCTIONS_HPP
31 
32 #include "CDPL/Grid/APIPrefix.hpp"
33 
34 
35 namespace CDPL
36 {
37 
38  namespace Base
39  {
40 
41  class ControlParameterContainer;
42  }
43 
44  namespace Grid
45  {
46 
53 
60 
67 
73 
81 
89 
97 
104 
112 
120 
128 
135 
143 
151 
159 
166 
174 
182 
190 
197 
198  } // namespace Grid
199 } // namespace CDPL
200 
201 #endif // CDPL_GRID_CONTROLPARAMETERFUNCTIONS_HPP
Definition of the preprocessor macro CDPL_GRID_API.
#define CDPL_GRID_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Base class providing methods for the storage and lookup of control-parameter values.
Definition: ControlParameterContainer.hpp:93
CDPL_GRID_API void clearCUBECommentIsNameParameter(Base::ControlParameterContainer &cntnr)
Removes the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter from cntnr.
CDPL_GRID_API void setCDFOutputSinglePrecisionFloatsParameter(Base::ControlParameterContainer &cntnr, bool single_prec)
Sets the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr to single_prec...
CDPL_GRID_API double getCUBEInputDistanceScalingFactorParameter(const Base::ControlParameterContainer &cntnr)
Returns the value of the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter of cntn...
CDPL_GRID_API void setCUBEOutputDistanceScalingFactorParameter(Base::ControlParameterContainer &cntnr, double factor)
Sets the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter of cntnr to factor.
CDPL_GRID_API bool getStrictErrorCheckingParameter(const Base::ControlParameterContainer &cntnr)
Returns the value of the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr.
CDPL_GRID_API void setCUBECommentIsNameParameter(Base::ControlParameterContainer &cntnr, bool is_name)
Sets the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter of cntnr to is_name.
CDPL_GRID_API void setCUBEInputDistanceScalingFactorParameter(Base::ControlParameterContainer &cntnr, double factor)
Sets the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter of cntnr to factor.
CDPL_GRID_API bool hasCUBEOutputDistanceScalingFactorParameter(const Base::ControlParameterContainer &cntnr)
Tells whether cntnr carries an explicit Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR p...
CDPL_GRID_API bool hasStrictErrorCheckingParameter(const Base::ControlParameterContainer &cntnr)
Tells whether cntnr carries an explicit Grid::ControlParameter::STRICT_ERROR_CHECKING parameter.
CDPL_GRID_API bool hasCUBECommentIsNameParameter(const Base::ControlParameterContainer &cntnr)
Tells whether cntnr carries an explicit Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter.
CDPL_GRID_API void setStrictErrorCheckingParameter(Base::ControlParameterContainer &cntnr, bool strict)
Sets the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr to strict.
CDPL_GRID_API void clearCUBEOutputDistanceScalingFactorParameter(Base::ControlParameterContainer &cntnr)
Removes the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter from cntnr.
CDPL_GRID_API void clearStrictErrorCheckingParameter(Base::ControlParameterContainer &cntnr)
Removes the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter from cntnr.
CDPL_GRID_API bool getCDFOutputSinglePrecisionFloatsParameter(const Base::ControlParameterContainer &cntnr)
Returns the value of the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntn...
CDPL_GRID_API void clearCDFOutputSinglePrecisionFloatsParameter(Base::ControlParameterContainer &cntnr)
Removes the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter from cntnr.
CDPL_GRID_API double getCUBEOutputDistanceScalingFactorParameter(const Base::ControlParameterContainer &cntnr)
Returns the value of the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter of cnt...
CDPL_GRID_API bool hasCUBEInputDistanceScalingFactorParameter(const Base::ControlParameterContainer &cntnr)
Tells whether cntnr carries an explicit Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR pa...
CDPL_GRID_API void clearCUBEInputDistanceScalingFactorParameter(Base::ControlParameterContainer &cntnr)
Removes the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter from cntnr.
CDPL_GRID_API bool hasCDFOutputSinglePrecisionFloatsParameter(const Base::ControlParameterContainer &cntnr)
Tells whether cntnr carries an explicit Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS pa...
CDPL_GRID_API bool getCUBECommentIsNameParameter(const Base::ControlParameterContainer &cntnr)
Returns the value of the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter of cntnr.
The namespace of the Chemical Data Processing Library.