Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_Describable.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 #include "Teuchos_Describable.hpp"
00043 #include "Teuchos_TypeNameTraits.hpp"
00044 
00045 
00046 namespace Teuchos {
00047 
00048 
00049 const EVerbosityLevel Describable::verbLevel_default = VERB_DEFAULT;
00050 
00051 
00052 std::string Describable::description () const
00053 {
00054   const std::string objectLabel = this->getObjectLabel ();
00055   std::ostringstream oss;
00056   if (objectLabel.length ()) {
00057     oss << "\"" << objectLabel << "\": ";
00058   }
00059   oss << typeName (*this);
00060   return oss.str ();
00061 }
00062 
00063 void
00064 Describable::describe (FancyOStream& out_arg,
00065                        const EVerbosityLevel verbLevel) const
00066 {
00067   RCP<FancyOStream> out = rcpFromRef (out_arg);
00068   OSTab tab (out);
00069   *out << this->description () << std::endl;
00070 }
00071 
00072 void
00073 Describable::describe (std::ostream& out,
00074                        const EVerbosityLevel verbLevel) const
00075 {
00076   RCP<FancyOStream> fancyOut = getFancyOStream (rcpFromRef (out));
00077   this->describe (*fancyOut, verbLevel);
00078 }
00079 
00080 Describable::~Describable () {}
00081 
00082 } // namespace Teuchos
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines