Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_VerboseObject.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_VerboseObject.hpp"
00043 #include "Teuchos_GlobalMPISession.hpp"
00044 
00045 
00046 namespace Teuchos {
00047 
00048 
00049 // Private static data members
00050 
00051 
00052 RCP<FancyOStream>& VerboseObjectBase::privateDefaultOStream()
00053 {
00054   static RCP<FancyOStream> defaultOStream;
00055   if (defaultOStream.get()==NULL) {
00056     defaultOStream = fancyOStream(rcpFromRef(std::cout));
00057     defaultOStream->setOutputToRootOnly(0);
00058 //    if(GlobalMPISession::getNProc()>1)
00059 //      defaultOStream->setShowProcRank(true);
00060   }
00061   return defaultOStream;
00062 }
00063 
00064 
00065 // Public static member functions
00066 
00067 
00068 void VerboseObjectBase::setDefaultOStream(
00069   const RCP<FancyOStream> &defaultOStream
00070   )
00071 {
00072   privateDefaultOStream() = defaultOStream;
00073 }
00074 
00075 
00076 RCP<FancyOStream>
00077 VerboseObjectBase::getDefaultOStream()
00078 {
00079   return privateDefaultOStream();
00080 }
00081 
00082 
00083 // Constructors/Initializers
00084 
00085 
00086 VerboseObjectBase::VerboseObjectBase(
00087   const RCP<FancyOStream>   &oStream
00088   )
00089   : thisOverridingOStream_(null)
00090 {
00091   this->initializeVerboseObjectBase(oStream);
00092 }
00093 
00094 
00095 void VerboseObjectBase::initializeVerboseObjectBase(
00096   const RCP<FancyOStream>   &oStream
00097   )
00098 {
00099   thisOStream_ = oStream;
00100   informUpdatedVerbosityState();
00101 }
00102 
00103 
00104 const VerboseObjectBase&
00105 VerboseObjectBase::setOStream(const RCP<FancyOStream> &oStream) const
00106 {
00107   thisOStream_ = oStream;
00108   informUpdatedVerbosityState();
00109   return *this;
00110 }
00111 
00112 
00113 const VerboseObjectBase&
00114 VerboseObjectBase::setOverridingOStream(
00115   const RCP<FancyOStream> &oStream
00116   ) const
00117 {
00118   thisOverridingOStream_ = oStream;
00119   informUpdatedVerbosityState();
00120   return *this;
00121 }
00122 
00123 
00124 VerboseObjectBase&
00125 VerboseObjectBase::setLinePrefix(const std::string &linePrefix)
00126 {
00127   thisLinePrefix_ = linePrefix;
00128   informUpdatedVerbosityState();
00129   return *this;
00130 }
00131 
00132 
00133 // Query functions
00134 
00135 
00136 RCP<FancyOStream>
00137 VerboseObjectBase::getOStream() const
00138 {
00139   if(!is_null(thisOverridingOStream_))
00140     return thisOverridingOStream_;
00141   if(is_null(thisOStream_))
00142     return getDefaultOStream();
00143   return thisOStream_;
00144 }
00145 
00146 
00147 RCP<FancyOStream>
00148 VerboseObjectBase::getOverridingOStream() const
00149 {
00150   return thisOverridingOStream_;
00151 }
00152 
00153 
00154 std::string VerboseObjectBase::getLinePrefix() const
00155 {
00156   return thisLinePrefix_;
00157 }
00158 
00159 
00160 // Utility functions
00161 
00162 
00163 OSTab VerboseObjectBase::getOSTab(
00164   const int tabs,const std::string &linePrefix
00165   ) const
00166 {
00167   return OSTab(
00168     this->getOStream(), tabs, linePrefix.length()
00169     ? linePrefix : this->getLinePrefix()
00170     );
00171 }
00172 
00173 
00174 // protected
00175 
00176 
00177 void VerboseObjectBase::informUpdatedVerbosityState() const
00178 {}
00179 
00180 
00181 } // namespace Teuchos
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines