Classes | Public Member Functions | Static Public Attributes | List of all members
NullObject Class Reference

Singleton null-object class and instance. More...

Collaboration diagram for NullObject:
[legend]

Public Member Functions

const void * pointer () const
 A nullptr pointer content. More...
 
unsigned long value () const
 Zero valued integer content. More...
 
bool empty () const
 No elements. More...
 
label size () const
 Zero elements. More...
 
const NullObject & toc () const
 No-op method (for HashTable replacement) More...
 
const NullObject & sortedToc () const
 No-op method (for HashTable replacement) More...
 

Static Public Attributes

static const NullObject nullObject
 A unique null object. More...
 

Detailed Description

Singleton null-object class and instance.

Its contents occupy enough space to also be reinterpreted as another class with a null pointer or zero long for its first member, with additional zero parameters for safe casting to List etc.

Source files

Definition at line 58 of file nullObject.H.

Member Function Documentation

◆ pointer()

const void* pointer ( ) const
inline

A nullptr pointer content.

Definition at line 101 of file nullObject.H.

◆ value()

unsigned long value ( ) const
inline

Zero valued integer content.

Definition at line 107 of file nullObject.H.

◆ empty()

bool empty ( ) const
inline

No elements.

Definition at line 113 of file nullObject.H.

◆ size()

label size ( ) const
inline

Zero elements.

Definition at line 119 of file nullObject.H.

◆ toc()

const NullObject& toc ( ) const
inline

No-op method (for HashTable replacement)

Definition at line 125 of file nullObject.H.

◆ sortedToc()

const NullObject& sortedToc ( ) const
inline

No-op method (for HashTable replacement)

Definition at line 131 of file nullObject.H.

Member Data Documentation

◆ nullObject

const Foam::NullObject nullObject
static

A unique null object.

Definition at line 95 of file nullObject.H.

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