Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_RequestMesg.hpp
1 /*
2 // @HEADER
3 //
4 // ***********************************************************************
5 //
6 // Teko: A package for block and physics based preconditioning
7 // Copyright 2010 Sandia Corporation
8 //
9 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40 //
41 // ***********************************************************************
42 //
43 // @HEADER
44 
45 */
46 
47 #ifndef __Teko_RequestMesg_hpp__
48 #define __Teko_RequestMesg_hpp__
49 
50 #include <string>
51 #include <iostream>
52 
53 #include "Teuchos_RCP.hpp"
54 #include "Teuchos_ParameterList.hpp"
55 
56 namespace Teko {
57 
58 class RequestMesg {
59  public:
67  explicit RequestMesg(const std::string& name, unsigned int tag = 0) : name_(name), tag_(tag) {}
68 
75  explicit RequestMesg(const Teuchos::RCP<const Teuchos::ParameterList>& pl) : paramList_(pl) {
76  fromParameterList(*paramList_);
77  }
78 
80  virtual ~RequestMesg() {}
81 
83  std::string getName() const { return name_; }
84 
86  unsigned int getTag() const { return tag_; }
87 
89  const Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const {
90  return paramList_.getConst();
91  }
92 
93  protected:
94  void fromParameterList(const Teuchos::ParameterList& pl) {
95  name_ = "Parameter List";
96  tag_ = 0;
97  if (pl.isParameter("Name")) name_ = pl.get<std::string>("Name");
98  if (pl.isParameter("Tag")) tag_ = pl.get<unsigned int>("Tag");
99  }
100 
101  std::string name_;
102  unsigned int tag_;
103  Teuchos::RCP<const Teuchos::ParameterList> paramList_;
104 };
105 
106 // simple stream interface for RequestMesg
107 inline std::ostream& operator<<(std::ostream& os, const Teko::RequestMesg& rm) {
108  os << "RequestMesg <"
109  << "name = \"" << rm.getName() << "\", "
110  << "tag = " << rm.getTag() << ">";
111 
112  return os;
113 }
114 
115 } // end namespace Teko
116 
117 #endif