nullObject.H File Reference

Include dependency graph for nullObject.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Namespaces
namespace	Foam
	Namespace for OpenFOAM.

Functions
Istream &	operator>> (Istream &is, const NullObject &) noexcept
	Read from Istream consumes no content, does not change NullObject.
Ostream &	operator<< (Ostream &os, const NullObject &) noexcept
	Write to Ostream emits no content.
template<class T>
const T *	NullObjectPtr () noexcept
	Const pointer (of type T) to the nullObject.
template<class T>
T *	NullObjectPtr_constCast () noexcept
	Non-const pointer (of type T) to the nullObject. Only use when nothing will be written into it!
template<class T>
const T &	NullObjectRef () noexcept
	Const reference (of type T) to the nullObject.
template<class T>
T &	NullObjectRef_constCast () noexcept
	Non-const reference (of type T) to the nullObject Only use when nothing will be written into it!
template<class T>
bool	isNull (const T *ptr) noexcept
	True if ptr is a pointer (of type T) to the nullObject.
template<class T>
bool	isNull (const T &obj) noexcept
	True if obj is a reference (of type T) to the nullObject.
template<class T>
bool	notNull (const T *ptr) noexcept
	True if ptr is not a pointer (of type T) to the nullObject.
template<class T>
bool	notNull (const T &obj) noexcept
	True if obj is not a reference (of type T) to the nullObject.

Variables
const NullObject *	nullObjectPtr = &Foam::NullObject::nullObject
	Pointer to the unique nullObject.

Detailed Description

Original source file nullObject.H

Definition in file nullObject.H.