src/OpenFOAM/memory/autoPtr/autoPtr.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::autoPtr
  26
  27 Description
  28     An auto-pointer similar to the STL auto_ptr but with automatic casting
  29     to a reference to the type and with pointer allocation checking on access.
  30
  31 SourceFiles
  32     autoPtrI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef autoPtr_H
  37 #define autoPtr_H
  38
  39 #include <cstddef>
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class autoPtr Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class T>
  51 class autoPtr
  52 {
  53     // Public data
  54
  55         //- Pointer to object
  56         mutable T* ptr_;
  57
  58
  59 public:
  60
  61     // Constructors
  62
  63         //- Store object pointer
  64         inline explicit autoPtr(T* = 0);
  65
  66         //- Construct as copy by transfering pointer to this autoPtr and
  67         //  setting the arguments pointer to NULL
  68         inline autoPtr(const autoPtr<T>&);
  69
  70
  71     //- Destructor, delete object if pointer is not NULL
  72     inline ~autoPtr();
  73
  74
  75     // Member Functions
  76
  77         // Check
  78
  79             //- Return true if the autoPtr is empty (ie, no pointer set).
  80             inline bool empty() const;
  81
  82             //- Return true if the autoPtr valid (ie, the pointer is set).
  83             inline bool valid() const;
  84
  85
  86         // Edit
  87
  88             //- Return object pointer for reuse
  89             inline T* ptr();
  90
  91             //- Set pointer to that given.
  92             //  If object pointer already set issue a FatalError.
  93             inline void set(T*);
  94
  95             //- If object pointer already set, delete object and set to given
  96             //  pointer
  97             inline void reset(T* = 0);
  98
  99             //- Delete object (if the pointer is valid) and set pointer to NULL.
 100             inline void clear();
 101
 102
 103         // Member operators
 104
 105             //- Return reference to the object data
 106             inline T& operator()();
 107
 108             //- Return const reference to the object data
 109             inline const T& operator()() const;
 110
 111             //- Const cast to the underlying type reference
 112             inline operator const T&() const;
 113
 114             //- Return object pointer
 115             inline T* operator->();
 116
 117             //- Return const object pointer
 118             inline const T* operator->() const;
 119
 120             //- Take over the object pointer from parameter
 121             inline void operator=(const autoPtr<T>&);
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #include "autoPtrI.H"
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //