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

StringArrayParamDef.h

Go to the documentation of this file.
00001 #ifndef _STRING_ARRAY_PARAM_DEF_H
00002 #define _STRING_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: StringArrayParamDef.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 <vector>
00038 #include <string>
00039 
00040 using std::string;
00041 using std::vector;
00042 using std::auto_ptr;
00043 
00046 namespace Parameters {
00047 
00051         class StringArrayParamDef: public Parameters::ParamDef
00052         {    
00053           public:
00057             StringArrayParamDef();
00058             
00062             StringArrayParamDef(const string & paramName, const string  & helpText, const string & promptText, 
00063                bool requiredBoolVal, auto_ptr< int > maxLen, auto_ptr< vector < string > > defaultVals);
00064 
00068             virtual ~StringArrayParamDef();
00069             
00070             /*
00071              * Accessor for the maxLen
00072              * @return the maxlen value as an auto_ptr to int
00073              * if defined for this pdef, then the auto_ptr will 
00074              * point to something meaningful, else null.
00075              */
00076             auto_ptr<int> getMaxLen();
00077 
00078             /*
00079              * Accessor for the default value.
00080              * @return the default value as an auto_ptr to a vector of string.
00081              * if defined for this pdef, then the auto_ptr will 
00082              * point to something meaningful, else null.
00083              */
00084             auto_ptr< vector<string> > getDefaultValues();
00085             
00086             /*
00087              * Accessor for the flag indicating if there is a maxLen
00088              * @return the flag indicating if there is a maxlen value as a ptr to int
00089              */
00090             bool getHasMaxLen();
00091 
00092             /*
00093              * Accessor for the flag indicating if there is a default value.
00094              * @return the flag indicating if there is a default value as a vector of string.
00095              */
00096             bool getHasDefaultValues();
00097 
00098           private:
00099             vector<string> defaultValues_m;
00100             int maxLen_m;
00101 
00102             bool hasDefaultValues_m;
00103             bool hasMaxLen_m;
00104         };
00105 
00106 }
00107 #endif 

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