autoPtr.H 3.98 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
Mark Olesen's avatar
Mark Olesen committed
5
    \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
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
     \\/     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 2 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, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

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:

    // Constructors

        //- Store object pointer
Mark Olesen's avatar
Mark Olesen committed
65
        inline explicit autoPtr(T* = 0);
66
67
68
69
70
71
72
73
74
75
76
77
78
79

        //- Construct as copy by transfering pointer to this autoPtr and
        //  setting the arguments pointer to NULL
        inline autoPtr(const autoPtr<T>&);


    // Destructor

        //- Delete object if pointer is not NULL
        inline ~autoPtr();


    // Member Functions

80
        // Check
81

82
83
            //- Return true if the autoPtr is empty (ie, no pointer set).
            inline bool empty() const;
84

85
86
            //- Return true if the autoPtr valid (ie, the pointer is set).
            inline bool valid() const;
87
88


89
        // Edit
90

91
92
            //- Return object pointer for reuse
            inline T* ptr();
93

94
95
96
            //- Set pointer to that given.
            //  If object pointer already set issue a FatalError.
            inline void set(T*);
97

98
99
100
            //- If object pointer already set, delete object and set to given
            //  pointer
            inline void reset(T* = 0);
101

102
103
            //- Delete object and set pointer to NULL, if the pointer is valid.
            inline void clear();
104
105


106
        // Member operators
107

108
109
            //- Return reference to the object data
            inline T& operator()();
110

111
112
            //- Return const reference to the object data
            inline const T& operator()() const;
113

114
115
            // inline T& operator*();
            // inline const T& operator*() const;
116

117
            inline operator const T&() const;
118

119
120
            //- Return object pointer
            inline T* operator->();
121

122
123
            //- Return const object pointer
            inline const T* operator->() const;
124

125
126
            //- Take over object pointer from parameter
            inline void operator=(const autoPtr<T>&);
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "autoPtrI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //