Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_StandardCompositionMacros.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_STANDARD_COMPOSITION_MACROS_HPP
00043 #define TEUCHOS_STANDARD_COMPOSITION_MACROS_HPP
00044 
00049 #include "Teuchos_RCP.hpp"
00050 
00077 #define STANDARD_COMPOSITION_MEMBERS( TYPE, NAME ) \
00078   void set_ ## NAME (const Teuchos::RCP< TYPE >& NAME ## _in ) \
00079   { NAME ## _ = NAME ## _in ; } \
00080   Teuchos::RCP< TYPE > get_ ## NAME() const \
00081   { return NAME ## _; } \
00082   TYPE& NAME() \
00083   { return *NAME ## _; } \
00084   const TYPE& NAME() const \
00085   { return *NAME ## _; } \
00086 private: \
00087   Teuchos::RCP< TYPE > NAME ## _; \
00088 public: \
00089   typedef Teuchos::RCP< TYPE > NAME ## _ptr_t
00090 
00117 #define STANDARD_NONCONST_COMPOSITION_MEMBERS( TYPE, NAME ) \
00118   void set_ ## NAME ( const Teuchos::RCP< TYPE >& NAME ## _in ) \
00119   { NAME ## _ = NAME ## _in ; } \
00120   Teuchos::RCP< TYPE > get_ ## NAME() const \
00121   { return NAME ## _; } \
00122   TYPE& NAME() const \
00123   { return *NAME ## _; } \
00124 private: \
00125   Teuchos::RCP< TYPE > NAME ## _; \
00126 public: \
00127   typedef Teuchos::RCP< TYPE > NAME ## _ptr_t
00128 
00156 #define STANDARD_CONST_COMPOSITION_MEMBERS( TYPE, NAME ) \
00157 public: \
00158   void set_ ## NAME ( const Teuchos::RCP< const TYPE >& NAME ## _in ) \
00159   { NAME ## _ = NAME ## _in ; } \
00160   Teuchos::RCP< const TYPE > get_ ## NAME() const \
00161   { return NAME ## _; } \
00162   const TYPE& NAME() const \
00163   { return *NAME ## _; } \
00164 private: \
00165   Teuchos::RCP< const TYPE > NAME ## _; \
00166 public: \
00167   typedef Teuchos::RCP< const TYPE > NAME ## _ptr_t
00168 
00169 #endif  // TEUCHOS_STANDARD_COMPOSITION_MACROS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines