Teko Version of the Day
Teko_RequestMesg.hpp
00001 /*
00002 // @HEADER
00003 // 
00004 // ***********************************************************************
00005 // 
00006 //      Teko: A package for block and physics based preconditioning
00007 //                  Copyright 2010 Sandia Corporation 
00008 //  
00009 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00010 // the U.S. Government retains certain rights in this software.
00011 //  
00012 // Redistribution and use in source and binary forms, with or without
00013 // modification, are permitted provided that the following conditions are
00014 // met:
00015 //  
00016 // 1. Redistributions of source code must retain the above copyright
00017 // notice, this list of conditions and the following disclaimer.
00018 //  
00019 // 2. Redistributions in binary form must reproduce the above copyright
00020 // notice, this list of conditions and the following disclaimer in the
00021 // documentation and/or other materials provided with the distribution.
00022 //  
00023 // 3. Neither the name of the Corporation nor the names of the
00024 // contributors may be used to endorse or promote products derived from
00025 // this software without specific prior written permission. 
00026 //  
00027 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00028 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00031 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
00036 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 //  
00039 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
00040 // 
00041 // ***********************************************************************
00042 // 
00043 // @HEADER
00044 
00045 */
00046 
00047 #ifndef __Teko_RequestMesg_hpp__
00048 #define __Teko_RequestMesg_hpp__
00049 
00050 #include <string>
00051 #include <iostream>
00052 
00053 #include "Teuchos_RCP.hpp"
00054 #include "Teuchos_ParameterList.hpp"
00055 
00056 namespace Teko {
00057 
00058 class RequestMesg {
00059 public:
00067    explicit RequestMesg(const std::string & name,unsigned int tag=0)
00068       : name_(name), tag_(tag) {}
00069 
00076    explicit RequestMesg(const Teuchos::RCP<const Teuchos::ParameterList> & pl)
00077       : paramList_(pl) 
00078    {
00079       fromParameterList(*paramList_);
00080    }
00081 
00083    virtual ~RequestMesg() {}
00084 
00086    std::string getName() const
00087    { return name_; }
00088 
00090    unsigned int getTag() const
00091    { return tag_; }
00092 
00094    const Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const
00095    { return paramList_.getConst(); }
00096    
00097 protected:
00098 
00099    void fromParameterList(const Teuchos::ParameterList & pl)
00100    {
00101       name_ = "Parameter List";
00102       tag_ = 0;
00103       if(pl.isParameter("Name"))
00104          name_ = pl.get<std::string>("Name");
00105       if(pl.isParameter("Tag"))
00106          tag_ = pl.get<unsigned int>("Tag");
00107    }
00108 
00109    std::string name_;
00110    unsigned int tag_;
00111    Teuchos::RCP<const Teuchos::ParameterList> paramList_;
00112 };
00113 
00114 // simple stream interface for RequestMesg
00115 inline std::ostream & operator<<(std::ostream & os,const Teko::RequestMesg & rm)
00116 {
00117    os << "RequestMesg <"
00118       << "name = \"" << rm.getName() << "\", "
00119       << "tag = " << rm.getTag() << ">";
00120  
00121    return os;
00122 }
00123 
00124 } // end namespace Teko
00125 
00126 #endif
 All Classes Files Functions Variables