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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // 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
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 
00030 #include "Teuchos_ParameterEntry.hpp" // class definition
00031 #include "Teuchos_ParameterList.hpp"   // for sublists
00032 
00033 
00034 namespace Teuchos {
00035 
00036 
00037 ParameterEntry::ParameterEntry() : 
00038   isUsed_(false),
00039   isDefault_(false)
00040 {}
00041 
00042 
00043 ParameterEntry::ParameterEntry(const ParameterEntry& source)
00044 {
00045   operator=(source);
00046 }
00047 
00048 
00049 ParameterEntry& ParameterEntry::operator=(const ParameterEntry& source)
00050 {
00051   if (&source == this)
00052     return *this;
00053 
00054   val_ = source.val_;
00055   isUsed_ = source.isUsed_;
00056   isDefault_ = source.isDefault_;
00057   docString_ = source.docString_;
00058   validator_ = source.validator_;
00059 
00060   return *this;
00061 }
00062 
00063 
00064 void ParameterEntry::setAnyValue(
00065   const any &value_in, bool isDefault_in
00066   )
00067 {
00068   val_ = value_in;
00069   isDefault_ = isDefault_in;
00070   validator_ = null;
00071   isUsed_ = false;
00072   docString_ = "";
00073 }
00074 
00075 
00076 void ParameterEntry::setValidator(
00077   RCP<const ParameterEntryValidator> const& validator_in
00078   )
00079 {
00080   validator_ = validator_in;
00081 }
00082 
00083 
00084 void ParameterEntry::setDocString(const std::string &docString_in)
00085 {
00086   docString_ = docString_in;
00087 }
00088 
00089 
00090 ParameterList& ParameterEntry::setList(
00091   bool isDefault_in, const std::string &docString_in
00092   )
00093 {
00094   val_ = ParameterList();
00095   isDefault_ = isDefault_in;
00096   isUsed_ = true;
00097   docString_ = docString_in;
00098   return any_cast<ParameterList>( val_ );
00099 }
00100 
00101 
00102 bool ParameterEntry::isList() const
00103 {
00104   return ( val_.empty() ? false : val_.type() == typeid(ParameterList) );
00105 }
00106 
00107 
00108 std::ostream& ParameterEntry::leftshift(std::ostream& os, bool printFlags) const
00109 {
00110   if( !this->isList() ) os << val_;
00111 
00112   if(printFlags) {
00113     if (isDefault_)
00114       os << "   [default]";
00115     else if (!isUsed_)
00116       os << "   [unused]";
00117   }
00118 
00119   return os;
00120 }
00121 
00122 
00123 // private
00124 
00125 
00126 void ParameterEntry::reset()
00127 {
00128   //delete val_;
00129   isUsed_ = false;
00130   isDefault_ = false;
00131 }
00132 
00133 
00134 } // namespace Teuchos
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines