/usr/include/trilinos/Teuchos_StandardCompositionMacros.hpp is in libtrilinos-teuchos-dev 12.4.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_STANDARD_COMPOSITION_MACROS_HPP
#define TEUCHOS_STANDARD_COMPOSITION_MACROS_HPP
/*! \file Teuchos_StandardCompositionMacros.hpp \brief Macro that adds
<<std comp>> members as attribute members for any class.
*/
#include "Teuchos_RCP.hpp"
/** \brief Macro that adds <<std comp>> members for a composition association.
*
* This form is for when the object being held will have const attributes
* the same as the <tt>this</tt> object.
*
* For example, if you want to include a <<std comp>> association
* with an non-const object of type MyClass of the name my_object you
* would include the macro in the public section of YourClass
* declaration as follows:
*
\verbatim
class YourClass {
public:
STANDARD_COMPOSITION_MEMBERS( MyClass, my_object );
};
\endverbatim
*
* Note that the macro adds the following data member
* to the class declaration:<br>
\verbatim
private:
Teuchos::RCP< TYPE > NAME_;
\endverbatim
*
* \ingroup StandardContainmentMacros_grp
*/
#define STANDARD_COMPOSITION_MEMBERS( TYPE, NAME ) \
void set_ ## NAME (const Teuchos::RCP< TYPE >& NAME ## _in ) \
{ NAME ## _ = NAME ## _in ; } \
Teuchos::RCP< TYPE > get_ ## NAME() const \
{ return NAME ## _; } \
TYPE& NAME() \
{ return *NAME ## _; } \
const TYPE& NAME() const \
{ return *NAME ## _; } \
private: \
Teuchos::RCP< TYPE > NAME ## _; \
public: \
typedef Teuchos::RCP< TYPE > NAME ## _ptr_t
/** \brief Macro that adds <<std comp>> members for a composition association.
*
* This form is for when the object being held will have non-const attributes
* irrespective of the const of <tt>this</tt>.
*
* For example, if you want to include a <<std comp>> association
* with an non-const object of type MyClass of the name my_object you
* would include the macro in the public section of YourClass
* declaration as follows:
*
\verbatim
class YourClass {
public:
STANDARD_NONCONST_COMPOSITION_MEMBERS( MyClass, my_object );
};
\endverbatim
*
* Note that the macro adds the following data member
* to the class declaration:<br>
\verbatim
private:
Teuchos::RCP< TYPE > NAME_;
\endverbatim
*
* \ingroup StandardContainmentMacros_grp
*/
#define STANDARD_NONCONST_COMPOSITION_MEMBERS( TYPE, NAME ) \
void set_ ## NAME ( const Teuchos::RCP< TYPE >& NAME ## _in ) \
{ NAME ## _ = NAME ## _in ; } \
Teuchos::RCP< TYPE > get_ ## NAME() const \
{ return NAME ## _; } \
TYPE& NAME() const \
{ return *NAME ## _; } \
private: \
Teuchos::RCP< TYPE > NAME ## _; \
public: \
typedef Teuchos::RCP< TYPE > NAME ## _ptr_t
/** \brief Macro that adds <<std comp>> members for a composition association
* where the contained object is always constant.
*
* This form is for when the object being held will have const attributes
* irrespective of the const of <tt>this</tt>.
*
* For example, if you want to include a <<std comp>> association
* with a const object of type MyClass of the name my_object you
* would include the macro in the public section of YourClass
* declaration as follows:
*
\verbatim
class YourClass {
public:
STANDARD_CONST_COMPOSITION_MEMBERS( MyClass, my_object );
};
\endverbatim
*
* Note that the macro adds the following data member
* to the class declaration:<br>
\verbatim
private:
NAME_ptr_t NAME_;
\endverbatim
*
* \ingroup StandardContainmentMacros_grp
*/
#define STANDARD_CONST_COMPOSITION_MEMBERS( TYPE, NAME ) \
public: \
void set_ ## NAME ( const Teuchos::RCP< const TYPE >& NAME ## _in ) \
{ NAME ## _ = NAME ## _in ; } \
Teuchos::RCP< const TYPE > get_ ## NAME() const \
{ return NAME ## _; } \
const TYPE& NAME() const \
{ return *NAME ## _; } \
private: \
Teuchos::RCP< const TYPE > NAME ## _; \
public: \
typedef Teuchos::RCP< const TYPE > NAME ## _ptr_t
#endif // TEUCHOS_STANDARD_COMPOSITION_MACROS_HPP
|