src/OpenFOAM/memory/Xfer/XferI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 // * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * * //
  28
  29 template<class T>
  30 inline const Foam::Xfer<T>& Foam::Xfer<T>::null()
  31 {
  32     return *reinterpret_cast< Xfer<T>* >(0);
  33 }
  34
  35
  36 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  37
  38 template<class T>
  39 inline Foam::Xfer<T>::Xfer(T* p)
  40 :
  41     ptr_(p ? p : new T)
  42 {}
  43
  44
  45 template<class T>
  46 inline Foam::Xfer<T>::Xfer(T& t, bool allowTransfer)
  47 :
  48     ptr_(new T)
  49 {
  50     if (allowTransfer)
  51     {
  52         ptr_->transfer(t);
  53     }
  54     else
  55     {
  56         ptr_->operator=(t);
  57     }
  58 }
  59
  60
  61 template<class T>
  62 inline Foam::Xfer<T>::Xfer(const T& t)
  63 :
  64     ptr_(new T)
  65 {
  66     ptr_->operator=(t);
  67 }
  68
  69
  70 template<class T>
  71 inline Foam::Xfer<T>::Xfer(const Xfer<T>& t)
  72 :
  73     ptr_(new T)
  74 {
  75     ptr_->transfer(*(t.ptr_));
  76 }
  77
  78
  79 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  80
  81 template<class T>
  82 inline Foam::Xfer<T>::~Xfer()
  83 {
  84     delete ptr_;
  85     ptr_ = 0;
  86 }
  87
  88
  89 // * * * * * * * * * * * * *  Member Functions * * * * * * * * * * * * * * * //
  90
  91
  92 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
  93
  94 template<class T>
  95 inline void Foam::Xfer<T>::operator=(T& t)
  96 {
  97     ptr_->transfer(t);
  98 }
  99
 100
 101 template<class T>
 102 inline void Foam::Xfer<T>::operator=(const Xfer<T>& t)
 103 {
 104     // silently ignore attempted copy to self
 105     if (this != &t)
 106     {
 107         ptr_->transfer(*(t.ptr_));
 108     }
 109 }
 110
 111
 112 template<class T>
 113 inline T& Foam::Xfer<T>::operator()() const
 114 {
 115     return *ptr_;
 116 }
 117
 118
 119 template<class T>
 120 inline T* Foam::Xfer<T>::operator->() const
 121 {
 122     return ptr_;
 123 }
 124
 125
 126 // * * * * * * * * * * * * *  Helper Functions * * * * * * * * * * * * * * * //
 127
 128
 129 template<class T>
 130 inline Foam::Xfer<T> Foam::xferCopy(const T& t)
 131 {
 132     return Foam::Xfer<T>(t);
 133 }
 134
 135
 136 template<class T>
 137 inline Foam::Xfer<T> Foam::xferMove(T& t)
 138 {
 139     return Foam::Xfer<T>(t, true);
 140 }
 141
 142
 143 template<class T>
 144 inline Foam::Xfer<T> Foam::xferTmp(Foam::tmp<T>& tt)
 145 {
 146     return Foam::Xfer<T>(tt(), tt.isTmp());
 147 }
 148
 149
 150 template<class To, class From>
 151 inline Foam::Xfer<To> Foam::xferCopyTo(const From& t)
 152 {
 153     Foam::Xfer<To> xf;
 154     xf() = t;
 155     return xf;
 156 }
 157
 158
 159 template<class To, class From>
 160 inline Foam::Xfer<To> Foam::xferMoveTo(From& t)
 161 {
 162     Foam::Xfer<To> xf;
 163     xf().transfer(t);
 164     return xf;
 165 }
 166
 167
 168 // ************************************************************************* //