• Classes
  • Modules
  • Namespaces
  • Files
  • Related Pages
  • File List
  • File Members

DoubleArrayParamDef.h

Go to the documentation of this file.
00001 #ifndef _DOUBLE_ARRAY_PARAM_DEF_H
00002 #define _DOUBLE_ARRAY_PARAM_DEF_H
00003 /*******************************************************************************
00004 *    ALMA - Atacama Large Millimiter Array
00005 *    (c) Associated Universities Inc., 2002 
00006 *    (c) European Southern Observatory, 2002
00007 *    Copyright by ESO (in the framework of the ALMA collaboration)
00008 *    and Cosylab 2002, All rights reserved
00009 *
00010 *    This library is free software; you can redistribute it and/or
00011 *    modify it under the terms of the GNU Lesser General Public
00012 *    License as published by the Free Software Foundation; either
00013 *    version 2.1 of the License, or (at your option) any later version.
00014 *
00015 *    This library is distributed in the hope that it will be useful,
00016 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 *    Lesser General Public License for more details.
00019 *
00020 *    You should have received a copy of the GNU Lesser General Public
00021 *    License along with this library; if not, write to the Free Software
00022 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
00023 *
00024 * "@(#) $Id: DoubleArrayParamDef.h,v 1.3 2006/11/29 23:01:26 sharring Exp $"
00025 *
00026 * who       when      what
00027 * --------  --------  ----------------------------------------------
00028 * sharring  10/27/04  created
00029 */
00030 
00031 #ifndef __cplusplus
00032 #error This is a C++ include file and cannot be used from plain C
00033 #endif
00034 
00035 #include <ParamDef.h>
00036 #include <memory>
00037 #include <string>
00038 #include <vector>
00039 
00040 using std::auto_ptr;
00041 using std::string;
00042 using std::vector;
00043 
00046 using std::auto_ptr;
00047 
00048 namespace Parameters {
00049 
00053         class DoubleArrayParamDef: public Parameters::ParamDef
00054         {    
00055           public:
00059             DoubleArrayParamDef();
00060             
00064             DoubleArrayParamDef(const string & paramName, const string & helpText, const string & promptText, 
00065                bool requiredBoolVal, auto_ptr< string > unitsText, auto_ptr< int > maxLen, auto_ptr< vector < double > > defaultVals);
00066 
00070             virtual ~DoubleArrayParamDef();
00071             
00072             /*
00073              * Accessor for the units. 
00074              * @return the units as an  auto_ptr to a string; 
00075              * if units have been defined for this pdef, then the auto_ptr will 
00076              * point to a string of the units, else it will have be null. 
00077              */
00078             auto_ptr<string> getUnits();
00079 
00080             /*
00081              * Accessor for the maxLen
00082              * @return the maxlen value as a ptr to int
00083              * if maxLen has been defined for this pdef, then the auto_ptr will 
00084              * point to an int of the maxLen, else it will pt to a null. 
00085              */
00086             auto_ptr<int> getMaxLen();
00087 
00088             /*
00089              * Accessor for the default value.
00090              * @return the default value as a vector of double
00091              * if default values have been defined for this pdef, then the auto_ptr will 
00092              * point to a vector of doubles of the defaultvalues, else it will pt to a null. 
00093              */
00094             auto_ptr< vector<double> > getDefaultValues();
00095             
00096             /*
00097              * Accessor for the flag indicating if there are units
00098              * @return the flag indicating if there are units 
00099              */
00100             bool getHasUnits();
00101 
00102             /*
00103              * Accessor for flag indicating if there is maxLen
00104              * @return the flag indicating if there is maxlen value 
00105              */
00106             bool getHasMaxLen();
00107 
00108             /*
00109              * Accessor for the flag indicating if there is a default value.
00110              * @return the flag indicating if there is a default value
00111              */
00112             bool getHasDefaultValues();
00113 
00114           private:
00115             vector<double> defaultValues_m;
00116             int maxLen_m;
00117             string units_m;
00118 
00119             bool hasDefaultValues_m;
00120             bool hasMaxLen_m;
00121             bool hasUnits_m;
00122         };
00123 
00124 }
00125 #endif 

Generated on Thu Jan 12 2012 23:13:50 for ACS-10.0 C++ API by  doxygen 1.7.0