NullObject Class Reference

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

#include <nullObject.H>

Collaboration diagram for NullObject:

Public Member Functions
const void *	pointer () const noexcept
	A nullptr pointer content.
unsigned long	value () const noexcept
	Zero valued integer content.
bool	empty () const noexcept
	No elements.
label	size () const noexcept
	Zero elements.
const NullObject &	toc () const noexcept
	No-op method (for HashTable replacement).
const NullObject &	sortedToc () const noexcept
	No-op method (for HashTable replacement).
template<class T>
const NullObject &	operator= (const T &) const noexcept
	Swallow assignment (cf, std::ignore).

Static Public Attributes
static const NullObject	nullObject
	A unique null object.

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

• nullObject.H
• nullObject.C

Definition at line 56 of file nullObject.H.

Member Function Documentation

pointer()

const void * pointer ( ) const

inlinenoexcept

A nullptr pointer content.

Definition at line 114 of file nullObject.H.

References Foam::noexcept.

value()

unsigned long value ( ) const

inlinenoexcept

Zero valued integer content.

Definition at line 122 of file nullObject.H.

References Foam::noexcept.

empty()

bool empty ( ) const

inlinenoexcept

No elements.

Definition at line 130 of file nullObject.H.

References Foam::noexcept.

size()

label size ( ) const

inlinenoexcept

Zero elements.

Definition at line 138 of file nullObject.H.

References Foam::noexcept.

toc()

const NullObject & toc ( ) const

inlinenoexcept

No-op method (for HashTable replacement).

Definition at line 146 of file nullObject.H.

References Foam::noexcept.

sortedToc()

const NullObject & sortedToc ( ) const

inlinenoexcept

No-op method (for HashTable replacement).

Definition at line 154 of file nullObject.H.

References Foam::noexcept.

operator=()

template<class T>

const NullObject & operator= ( const T & ) const

inlinenoexcept

Swallow assignment (cf, std::ignore).

Definition at line 166 of file nullObject.H.

References Foam::T().

Here is the call graph for this function:

Member Data Documentation

nullObject

const Foam::NullObject nullObject

static

A unique null object.

Definition at line 106 of file nullObject.H.

---

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

• src/OpenFOAM/primitives/nullObject/nullObject.H
• src/OpenFOAM/primitives/nullObject/nullObject.C