Files
openfoam/src/OpenFOAM/memory/refCount/refCount.H
Mark Olesen 4cb763f9d2 STYLE: make null constructed lists constexpr, noexcept
- can assist the compiler in producing tighter code.
2018-03-19 13:53:28 +01:00

121 lines
2.9 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-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::refCount
Description
Reference counter for various OpenFOAM components.
See also
Foam::tmp
Foam::token::compound
\*---------------------------------------------------------------------------*/
#ifndef refCount_H
#define refCount_H
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class refCount Declaration
\*---------------------------------------------------------------------------*/
class refCount
{
// Private data
int count_;
public:
//- A non-counting (dummy) refCount
struct zero {};
// Constructors
//- Construct null initializing count to 0
constexpr refCount() noexcept
:
count_(0)
{}
// Member Functions
//- Return the current reference count
int count() const noexcept
{
return count_;
}
//- Return true if the reference count is zero
bool unique() const noexcept
{
return !count_;
}
// Member Operators
//- Increment the reference count
void operator++()
{
++count_;
}
//- Increment the reference count
void operator++(int)
{
++count_;
}
//- Decrement the reference count
void operator--()
{
--count_;
}
//- Decrement the reference count
void operator--(int)
{
--count_;
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //