Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_StandardMemberCompositionMacros.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 // ////////////////////////////////////////////////////////////
43 // Teuchos_StandardMemberCompositionMacros.hpp
44 
45 #ifndef TEUCHOS_STANDARD_MEMBER_COMPOSITION_MACROS_H
46 #define TEUCHOS_STANDARD_MEMBER_COMPOSITION_MACROS_H
47 
52 #include "Teuchos_ConfigDefs.hpp"
53 
84 #define STANDARD_MEMBER_COMPOSITION_MEMBERS( TYPE, NAME )\
85  void NAME ( const TYPE & NAME ## _in ) { NAME ## _ = NAME ## _in ; }\
86  const TYPE& NAME() const { return NAME ## _; }\
87 private:\
88  TYPE NAME ## _;\
89 public: \
90  typedef ::Teuchos::DummyDummyClass NAME ## DummyDummyClass_t
91 
92 // Note: Above, the 'using Teuchos::DummyDummyClass' statement is just there
93 // to allow (and require) the macro use of the form:
94 //
95 // STANDARD_MEMBER_COMPOSITION_MEMBERS( MyClass, my_attribute );
96 //
97 // which allows a semicolon at the end!
98 //
99 
100 #endif // TEUCHOS_STANDARD_MEMBER_COMPOSITION_MACROS_H
Teuchos header file which uses auto-configuration information to include necessary C++ headers...