Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_RequestHandler.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_RequestHandler_hpp__
48 #define __Teko_RequestHandler_hpp__
49 
50 #include <vector>
51 
52 #include "Teko_RequestCallback.hpp"
53 
54 #include "Teuchos_RCP.hpp"
55 
56 namespace Teko {
57 
70 public:
71  explicit RequestHandler();
72 
77  void addRequestCallback(const Teuchos::RCP<RequestCallbackBase> & callback);
78 
83  template <typename DataT>
84  DataT request(const RequestMesg & rm) const;
85 
90  template <typename DataT>
91  inline DataT request(const std::string & rm) const
92  { return request<DataT>(RequestMesg(rm)); }
93 
101  template <typename DataT>
102  void preRequest(const RequestMesg & rm) const;
103 
111  template <typename DataT>
112  inline void preRequest(const std::string & rm) const
113  { preRequest<DataT>(RequestMesg(rm)); }
114 
115 private:
116  // stores the callbacks to be used by this handler.
117  mutable std::vector<Teuchos::RCP<RequestCallbackBase> > callbacks_;
118 
119  // hidden from the user
120  RequestHandler(const RequestHandler & rh);
121  RequestHandler & operator=(const RequestHandler &);
122  const RequestHandler & operator=(const RequestHandler &) const;
123 };
124 
125 #include "Teko_RequestHandler_impl.hpp"
126 
127 }
128 
129 #endif
void preRequest(const RequestMesg &rm) const
void addRequestCallback(const Teuchos::RCP< RequestCallbackBase > &callback)
DataT request(const RequestMesg &rm) const
DataT request(const std::string &rm) const
void preRequest(const std::string &rm) const