Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ParameterEntry.cpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
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 Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 #include "Teuchos_ParameterEntry.hpp" // class definition
00044 #include "Teuchos_ParameterList.hpp"   // for sublists
00045 #include "Teuchos_TwoDArray.hpp"
00046 
00047 
00048 namespace Teuchos {
00049 
00050 
00051 ParameterEntry::ParameterEntry() : 
00052   isUsed_(false),
00053   isDefault_(false)
00054 {}
00055 
00056 
00057 ParameterEntry::ParameterEntry(const ParameterEntry& source)
00058 {
00059   operator=(source);
00060 }
00061 
00062 
00063 ParameterEntry& ParameterEntry::operator=(const ParameterEntry& source)
00064 {
00065   if (&source == this)
00066     return *this;
00067 
00068   val_ = source.val_;
00069   isUsed_ = source.isUsed_;
00070   isDefault_ = source.isDefault_;
00071   docString_ = source.docString_;
00072   validator_ = source.validator_;
00073 
00074   return *this;
00075 }
00076 
00077 void ParameterEntry::setAnyValue(
00078   const any &value_in, bool isDefault_in
00079   )
00080 {
00081   val_ = value_in;
00082   isDefault_ = isDefault_in;
00083   validator_ = null;
00084   isUsed_ = false;
00085   docString_ = "";
00086 }
00087 
00088 
00089 void ParameterEntry::setValidator(
00090   RCP<const ParameterEntryValidator> const& validator_in
00091   )
00092 {
00093   validator_ = validator_in;
00094 }
00095 
00096 
00097 void ParameterEntry::setDocString(const std::string &docString_in)
00098 {
00099   docString_ = docString_in;
00100 }
00101 
00102 
00103 ParameterList& ParameterEntry::setList(
00104   bool isDefault_in, const std::string &docString_in
00105   )
00106 {
00107   val_ = ParameterList();
00108   isDefault_ = isDefault_in;
00109   isUsed_ = true;
00110   docString_ = docString_in;
00111   return any_cast<ParameterList>( val_ );
00112 }
00113 
00114 
00115 bool ParameterEntry::isList() const
00116 {
00117   return ( val_.empty() ? false : val_.type() == typeid(ParameterList) );
00118 }
00119 
00120 std::ostream& ParameterEntry::leftshift(std::ostream& os, bool printFlags) const
00121 {
00122   if( !this->isList() ) os << val_;
00123 
00124   if(printFlags) {
00125     if (isDefault_)
00126       os << "   [default]";
00127     else if (!isUsed_)
00128       os << "   [unused]";
00129   }
00130 
00131   return os;
00132 }
00133 
00134 bool ParameterEntry::isTwoDArray() const{ 
00135   std::string formatString = getTwoDArrayTypeNameTraitsFormat();
00136   size_t starPos = formatString.find("*");
00137   std::string prefix = formatString.substr(0,starPos);
00138   std::string postfix = formatString.substr(starPos+1);
00139   std::string valueTypeName = val_.typeName();
00140   size_t prePos = valueTypeName.find(prefix);
00141   size_t postPos = valueTypeName.find(postfix);
00142   return (prePos != std::string::npos) && (prePos==0)
00143     && (postPos != std::string::npos) && (prePos < postPos);
00144 }
00145 
00146 bool ParameterEntry::isArray() const{ 
00147   std::string formatString = getArrayTypeNameTraitsFormat();
00148   size_t starPos = formatString.find("*");
00149   std::string prefix = formatString.substr(0,starPos);
00150   std::string postfix = formatString.substr(starPos+1);
00151   std::string valueTypeName = val_.typeName();
00152   size_t prePos = valueTypeName.find(prefix);
00153   size_t postPos = valueTypeName.find(postfix);
00154   return (prePos != std::string::npos) && (prePos==0)
00155     && (postPos != std::string::npos) && (prePos < postPos);
00156 }
00157 
00158 
00159 // private
00160 
00161 
00162 void ParameterEntry::reset()
00163 {
00164   //delete val_;
00165   isUsed_ = false;
00166   isDefault_ = false;
00167 }
00168 
00169 
00170 } // namespace Teuchos
00171 
00172 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines