nullObjectI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2014-2019 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 \*---------------------------------------------------------------------------*/
25 
26 template<class T>
27 inline const T& Foam::NullObjectRef()
28 {
29  return *reinterpret_cast<const T*>(nullObjectPtr);
30 }
31 
32 template<class T>
33 inline T&& Foam::NullObjectMove()
34 {
35  return move(const_cast<T&>(*reinterpret_cast<const T*>(nullObjectPtr)));
36 }
37 
38 template<class T>
39 inline const T* Foam::NullObjectPtr()
40 {
41  return reinterpret_cast<const T*>(nullObjectPtr);
42 }
43 
44 
45 template<class T>
46 inline bool Foam::isNull(const T& t)
47 {
48  return &t == NullObjectPtr<T>();
49 }
50 
51 template<class T>
52 inline bool Foam::notNull(const T& t)
53 {
54  return &t != NullObjectPtr<T>();
55 }
56 
57 
58 template<class T>
59 inline bool Foam::isNull(const T* t)
60 {
61  return t == NullObjectPtr<T>();
62 }
63 
64 template<class T>
65 inline bool Foam::notNull(const T* t)
66 {
67  return t != NullObjectPtr<T>();
68 }
69 
70 
71 // ************************************************************************* //
Foam::NullObjectMove
T && NullObjectMove()
Return reference to the nullObject of type T.
Definition: nullObjectI.H:33
Foam::isNull
bool isNull(const T &t)
Return true if t is a reference to the nullObject of type T.
Definition: nullObjectI.H:46
Foam::NullObjectPtr
const T * NullObjectPtr()
Return pointer to the nullObject of type T.
Definition: nullObjectI.H:39
Foam::nullObjectPtr
const NullObject * nullObjectPtr
Pointer to the unique nullObject.
Definition: nullObject.C:31
T
const volScalarField & T
Definition: createFieldRefs.H:2
Foam::notNull
bool notNull(const T &t)
Return true if t is not a reference to the nullObject of type T.
Definition: nullObjectI.H:52
Foam::NullObjectRef
const T & NullObjectRef()
Return reference to the nullObject of type T.
Definition: nullObjectI.H:27