Files
OpenFOAM-12/src/OpenFOAM/primitives/nullObject/nullObject.H

111 lines
3.0 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014-2016 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::nullObject
Description
Singleton null-object class and instance
SourceFiles
nullObjectI.H
nullObject.C
\*---------------------------------------------------------------------------*/
#ifndef nullObject_H
#define nullObject_H
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class nullObject Declaration
\*---------------------------------------------------------------------------*/
class NullObject
{
//- Private constructor
NullObject()
{}
//- Disallow default bitwise copy construct
NullObject(const NullObject&);
//- Disallow default bitwise assignment
void operator=(const NullObject&);
public:
//- The unique null object
static const NullObject nullObject;
};
//- Pointer to the unique nullObject
extern const NullObject* nullObjectPtr;
//- Return reference to the nullObject of type T
template<class T>
inline const T& NullObjectRef();
//- Return pointer to the nullObject of type T
template<class T>
inline const T* NullObjectPtr();
//- Return true if t is a reference to the nullObject of type T
template<class T>
inline bool isNull(const T& t);
//- Return true if t is not a reference to the nullObject of type T
template<class T>
inline bool notNull(const T& t);
//- Return true if t is a pointer to the nullObject of type T
template<class T>
inline bool isNull(const T* t);
//- Return true if t is not a pointer to the nullObject of type T
template<class T>
inline bool notNull(const T* t);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "nullObjectI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //