FEI Version of the Day
fei_Param.hpp
00001 /*
00002 // @HEADER
00003 // ************************************************************************
00004 //             FEI: Finite Element Interface to Linear Solvers
00005 //                  Copyright (2005) Sandia Corporation.
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the
00008 // U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Alan Williams (william@sandia.gov) 
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 */
00042 
00043 
00044 #ifndef _fei_Param_hpp_
00045 #define _fei_Param_hpp_
00046 
00047 #include <fei_macros.hpp>
00048 #include <string>
00049 
00050 namespace fei {
00058 class Param {
00059   public:
00061   enum ParamType {
00062     STRING = 0,
00063     DOUBLE = 1,
00064     INT = 2,
00065     BOOL = 3,
00066     VOID = 4,
00067     BAD_TYPE = 5
00068   };
00069 
00071   Param(const char* name, const char* value);
00073   Param(const char* name, double value);
00075   Param(const char* name, int value);
00077   Param(const char* name, const void* value);
00079   Param(const char* name, bool value);
00081   Param(const Param& src);
00082 
00084   virtual ~Param();
00085 
00087   Param& operator=(const Param& src);
00088 
00090   const std::string& getName() const;
00091 
00093   ParamType getType() const;
00094 
00097   const std::string& getStringValue() const;
00098 
00101   double getDoubleValue() const;
00102 
00105   int getIntValue() const;
00106 
00109   bool getBoolValue() const;
00110 
00113   const void* getVoidValue() const;
00114 
00115   private:
00116   ParamType type_;
00117   std::string name_;
00118   std::string string_value_;
00119   double double_value_;
00120   int int_value_;
00121   bool bool_value_;
00122   const void* void_value_;
00123 };
00124 }//namespace fei
00125 
00126 inline
00127 const std::string& fei::Param::getName() const
00128 {
00129   return name_;
00130 }
00131 
00132 inline
00133 fei::Param::ParamType fei::Param::getType() const
00134 {
00135   return type_;
00136 }
00137 
00138 inline
00139 const std::string& fei::Param::getStringValue() const
00140 {
00141   return string_value_;
00142 }
00143 
00144 inline
00145 double fei::Param::getDoubleValue() const
00146 {
00147   return double_value_;
00148 }
00149 
00150 inline
00151 int fei::Param::getIntValue() const
00152 {
00153   return int_value_;
00154 }
00155 
00156 inline
00157 bool fei::Param::getBoolValue() const
00158 {
00159   return bool_value_;
00160 }
00161 
00162 inline
00163 const void* fei::Param::getVoidValue() const
00164 {
00165   return void_value_;
00166 }
00167 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends