Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_Handleable.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_HANDLEABLE_HPP
43 #define TEUCHOS_HANDLEABLE_HPP
44 
45 #include "Teuchos_ConfigDefs.hpp"
46 #include "Teuchos_RCP.hpp"
47 
48 
49 namespace Teuchos
50 {
65  template <typename Base>
67  {
68  public:
70  virtual ~ConstHandleable(){}
71 
74  virtual RCP<const Base> getConstRcp() const = 0 ;
75  };
76 
91  template <typename Base>
92  class Handleable : public virtual ConstHandleable<Base>
93  {
94  public:
95 
97  virtual ~Handleable(){;}
98 
100  virtual RCP<Base> getRcp() = 0 ;
101 
102  };
103 }
104 
105 
119 #define TEUCHOS_GET_RCP(Base) \
120  virtual Teuchos::RCP<const Base > getConstRcp() const {return rcp(this);} \
121  virtual Teuchos::RCP<Base > getRcp() {return rcp(this);}
122 
134 #define TEUCHOS_GET_CONST_RCP(Base) \
135 virtual Teuchos::RCP<const Base > getConstRcp() const {return rcp(this);}
136 
137 
138 
139 
140 #endif // TEUCHOS_HANDLEABLE_HPP
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
virtual RCP< Base > getRcp()=0
Return a safely-created RCP to the base type.
Class Handleable provides an abstract interface for polymorphic conversion from raw pointers to smart...
virtual RCP< const Base > getConstRcp() const =0
Virtual dtorReturn a safely-created RCP to the base type.
Class ConstHandleable provides an abstract interface for polymorphic conversion from raw pointers to ...
Smart reference counting pointer class for automatic garbage collection.
Reference-counted pointer class and non-member templated function implementations.