File size: 4,695 Bytes
5a600cf | 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::autoPtr
Description
An auto-pointer similar to the STL auto_ptr but with automatic casting
to a reference to the type and with pointer allocation checking on access.
SourceFiles
autoPtrI.H
\*---------------------------------------------------------------------------*/
#ifndef autoPtr_H
#define autoPtr_H
#include <cstddef>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class autoPtr Declaration
\*---------------------------------------------------------------------------*/
template<class T>
class autoPtr
{
// Public data
//- Pointer to object
mutable T* ptr_;
public:
typedef T Type;
// Constructors
//- Store object pointer
inline explicit autoPtr(T* = nullptr);
//- Construct as copy by transferring pointer to this autoPtr and
// setting the arguments pointer to nullptr
inline autoPtr(const autoPtr<T>&);
//- Construct either by transferring pointer or cloning.
// Should only be called with type that supports cloning
inline autoPtr(const autoPtr<T>&, const bool reuse);
//- Destructor, delete object if pointer is not nullptr
inline ~autoPtr();
// Member Functions
// Check
//- Return true if the autoPtr is empty (ie, no pointer set)
inline bool empty() const;
//- Return true if the autoPtr valid (ie, the pointer is set)
inline bool valid() const;
// Edit
//- Return object pointer for reuse
inline T* ptr();
//- Set pointer to that given.
// If object pointer already set issue a FatalError
inline void set(T*);
//- If object pointer already set, delete object and set to given
// pointer
inline void reset(T* = nullptr);
//- Delete object (if the pointer is valid) and set pointer to
// nullptr
inline void clear();
//- Delete object if the pointer is valid and return true
// else return false
inline bool cleared();
// Member Operators
//- Return reference to the object data
inline T& operator()();
//- Return const reference to the object data
inline const T& operator()() const;
//- Return reference to the object data
inline T& operator*();
//- Return const reference to the object data
inline const T& operator*() const;
//- Const cast to the underlying type reference
inline operator const T&() const;
//- Return object pointer
inline T* operator->();
//- Return const object pointer
inline const T* operator->() const;
//- Take over the object pointer from parameter
inline void operator=(T*);
//- Take over the object pointer from parameter
inline void operator=(const autoPtr<T>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "autoPtrI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|