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

QuantityParam.h

Go to the documentation of this file.
00001 #ifndef _QUANTITY_PARAM_H
00002 #define _QUANTITY_PARAM_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: QuantityParam.h,v 1.2 2006/11/29 23:01:26 sharring Exp $"
00025 *
00026 * who       when      what
00027 * --------  --------  ----------------------------------------------
00028 * sharring  08/15/05  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 <Param.h>
00036 #include <string>
00037 #include <memory>
00038 
00039 using std::string;
00040 using std::auto_ptr;
00041 
00044 namespace Parameters {
00045 
00051         class QuantityParam : public Parameters::Param
00052         {    
00053                 public:
00054 
00058                         QuantityParam();
00059 
00065                         QuantityParam(const string & nameVal, auto_ptr<string> unitsVal);
00066             
00070                         virtual ~QuantityParam() = 0;
00071 
00072                         /*
00073                          * Accessor for the units.
00074                          * @return the units as an auto_ptr to a string
00075                          * if defined for this pdef, then the auto_ptr will 
00076                          * point to something meaningful, else null.
00077                          */
00078                         virtual auto_ptr< string > getUnits();
00079 
00080                         /*
00081                          * Accessor for flag indicating if there are units.
00082                          * @return the flag indicating if there are units.
00083                          */
00084                         virtual bool getHasUnits();
00085 
00091                         virtual string toString();
00092 
00093                 protected:
00094                         string units_m;
00095                         bool hasUnits_m;
00096         };
00097 }
00098 #endif 

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