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

BoolParamDef.h

Go to the documentation of this file.
00001 #ifndef _BOOL_PARAM_DEF_H
00002 #define _BOOL_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: BoolParamDef.h,v 1.4 2010/04/27 12:20:58 htischer 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 <string>
00037 #include <memory>
00038 #include <vector>
00039 
00040 using std::auto_ptr;
00041 using std::string;
00042 using std::vector;
00043 
00046 namespace Parameters {
00047 
00051         class BoolParamDef: public Parameters::ParamDef
00052         {    
00053           public:
00057             BoolParamDef();
00058             
00062                 BoolParamDef(const string & nameVal, const string & helpVal, const string & promptVal, 
00063                         bool isRequired, auto_ptr< bool > defaultVal);
00064 
00068             virtual ~BoolParamDef();
00069             
00070             /*
00071              * Accessor for the default value.
00072              * @return the default value 
00073              */
00074             bool getDefault();
00075             
00076             /*
00077              * Accessor for the the flag indicating if there is a default value.
00078              * @return the flag indicating if there is a default value
00079              */
00080             bool getHasDefault();
00081             
00082           private:
00083             bool defaultValue_m;
00084             bool hasDefault_m;
00085         };
00086 }
00087 #endif 

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