Zoltan2 Version of the Day
Zoltan2_DebugManager.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //   Zoltan2: A package of combinatorial algorithms for scientific computing
00006 //                  Copyright 2012 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Karen Devine      (kddevin@sandia.gov)
00039 //                    Erik Boman        (egboman@sandia.gov)
00040 //                    Siva Rajamanickam (srajama@sandia.gov)
00041 //
00042 // ***********************************************************************
00043 //
00044 // @HEADER
00045 
00050 #ifndef ZOLTAN2_DEBUGMANAGER_HPP
00051 #define ZOLTAN2_DEBUGMANAGER_HPP
00052 
00053 #include <Zoltan2_Parameters.hpp>
00054 #include <string>
00055 #include <iostream>
00056 #include <fstream>
00057 
00058 namespace Zoltan2
00059 {
00081 class DebugManager
00082 {
00083     public:
00084 
00095     DebugManager ( int rank, bool doPrinting, std::ofstream &debugOs, 
00096       MessageOutputLevel debugLevel) : myPID_(rank), debugLevel_(debugLevel),
00097         myOS_(static_cast<std::ostream *>(&debugOs)), fileOS_(&debugOs), 
00098         iPrint_(doPrinting) {}
00099 
00107     DebugManager ( int rank, bool doPrinting, std::ostream &debugOs, 
00108       MessageOutputLevel debugLevel) : myPID_(rank), debugLevel_(debugLevel),
00109         myOS_(&debugOs), fileOS_(NULL), iPrint_(doPrinting) {}
00110 
00113     virtual ~DebugManager()
00114     {
00115       myOS_->flush();
00116       if (fileOS_)
00117         fileOS_->close();
00118     }
00119 
00122     inline std::ostream *getOStream() const { return myOS_; };
00123 
00126     inline MessageOutputLevel getDebugLevel() const { return debugLevel_; };
00127 
00136     inline void print(MessageOutputLevel debugLevel, const std::string &output){
00137 #ifndef Z2_OMIT_ALL_STATUS_MESSAGES
00138       if (debugLevel <= debugLevel_ && iPrint_)
00139         *myOS_ << myPID_ << ": " << output << std::endl;
00140 #endif
00141     }
00142 
00152     inline void printInAllTasks(MessageOutputLevel debugLevel, const std::string &output){
00153 #ifndef Z2_OMIT_ALL_STATUS_MESSAGES
00154       if (debugLevel <= debugLevel_)
00155         *myOS_ << myPID_ << ": " << output << std::endl;
00156 #endif
00157     }
00158 
00167     inline void print(MessageOutputLevel debugLevel, const char *output){
00168 #ifndef Z2_OMIT_ALL_STATUS_MESSAGES
00169       if (debugLevel <= debugLevel_ && iPrint_)
00170         *myOS_ << myPID_ << ": " << output << std::endl;
00171 #endif
00172     }
00173 
00182     inline void printInAllTasks(MessageOutputLevel debugLevel, const char *output) {
00183 #ifndef Z2_OMIT_ALL_STATUS_MESSAGES
00184     if (debugLevel <= debugLevel_)
00185         *myOS_ << "PID =" << myPID_ << " " << output << std::endl;
00186 #endif
00187     }
00188 
00189     private:
00190 
00191     int myPID_;
00192     MessageOutputLevel debugLevel_;
00193     std::ostream *myOS_;
00194     std::ofstream *fileOS_;
00195     bool iPrint_;
00196 };
00197 
00198 } //namespace Zoltan2
00199 
00200 #endif