Public Member Functions | Protected Member Functions | List of all members
refCount Class Reference

Reference counter for various OpenFOAM components. More...

Inherited by Field< complexVector >, Field< DType >, Field< Foam::Field< Type > >, Field< Foam::FvWallInfoData >, Field< Foam::SymmTensor >, Field< Foam::Vector >, Field< label >, Field< LUType >, Field< PointType >, Field< scalar >, Field< symmTensor >, Field< T >, Field< tensor >, Field< TypeGrad >, Field< vector >, FieldField< Foam::Field, LUType >, FieldField< Foam::Field, scalar >, FieldField< Foam::Field, Type >, FieldField< Foam::fvPatchField, Foam::Vector >, FieldField< Foam::fvPatchField, scalar >, FieldField< Foam::fvPatchField, Type >, FieldField< Foam::fvsPatchField, Foam::FvWallInfoData >, FieldField< Foam::fvsPatchField, Type >, FieldField< Foam::pointPatchField, Foam::Vector >, FieldField< Foam::pointPatchField, scalar >, FieldField< Foam::pointPatchField, Type >, FieldField< fvPatchField, scalar >, FieldField< fvPatchField, symmTensor >, FieldField< fvPatchField, tensor >, FieldField< fvPatchField, vector >, FieldField< fvsPatchField, scalar >, FieldField< fvsPatchField, vector >, FieldField< PatchField, Type >, FieldField< pointPatchField, scalar >, FieldField< pointPatchField, Type >, FieldField< pointPatchField, vector >, Field< Type >, FieldField< Field, Type >, Function1< Type >, Function2< Type >, convectionScheme< Type >, d2dt2Scheme< Type >, ddtScheme< Type >, divScheme< Type >, gradScheme< Type >, laplacianScheme< Type, GType >, snGradScheme< Type >, fvMatrix< Type >, multivariateSurfaceInterpolationScheme< Type >, SubField< Type >, surfaceInterpolationScheme< Type >, token::compound, Function1< Foam::Vector >, Function1< Foam::Vector2D >, Function1< scalar >, Function2< scalar >, surfaceInterpolationScheme< GType >, and surfaceInterpolationScheme< scalar >.

Public Member Functions

int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 

Protected Member Functions

 refCount ()
 Construct null initialising count to 0. More...
 

Detailed Description

Reference counter for various OpenFOAM components.

See also
Foam::tmp Foam::token::compound

Definition at line 49 of file refCount.H.

Constructor & Destructor Documentation

◆ refCount()

refCount ( )
inlineprotected

Construct null initialising count to 0.

Definition at line 70 of file refCount.H.

Member Function Documentation

◆ count()

int count ( ) const
inline

Return the current reference count.

Definition at line 81 of file refCount.H.

◆ unique()

bool unique ( ) const
inline

Return true if the reference count is zero.

Definition at line 87 of file refCount.H.

◆ operator++() [1/2]

void operator++ ( )
inline

Increment the reference count.

Definition at line 96 of file refCount.H.

◆ operator++() [2/2]

void operator++ ( int  )
inline

Increment the reference count.

Definition at line 102 of file refCount.H.

◆ operator--() [1/2]

void operator-- ( )
inline

Decrement the reference count.

Definition at line 108 of file refCount.H.

◆ operator--() [2/2]

void operator-- ( int  )
inline

Decrement the reference count.

Definition at line 114 of file refCount.H.

The documentation for this class was generated from the following file: