Public Member Functions | List of all members
sharedRegIOobject< Type > Class Template Reference

Container for a pointer to a shared object, who's memory is managed by an object registry. Object lifetime is managed by reference counting, which limits the object types to those that inherit a reference count. More...

Inheritance diagram for sharedRegIOobject< Type >:
Inheritance graph
[legend]

Public Member Functions

 sharedRegIOobject ()
 Default construct. More...
 
template<class ... Args>
 sharedRegIOobject (const IOobject &io, const Args &... args)
 Construct from an IO object and additional arguments. More...
 
 sharedRegIOobject (const sharedRegIOobject< Type > &)=delete
 Disallow default bitwise copy construction. More...
 
 ~sharedRegIOobject ()
 Destructor. More...
 
bool valid () const
 Is this object set? More...
 
template<class ... Args>
void set (const IOobject &io, const Args &... args)
 Set the object. More...
 
Type & ref () const
 Return a reference to the object. More...
 
void clear ()
 Clear the object. More...
 
const Type & operator() () const
 Return a reference to the object. More...
 
void operator= (const sharedRegIOobject< Type > &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

template<class Type>
class Foam::sharedRegIOobject< Type >

Container for a pointer to a shared object, who's memory is managed by an object registry. Object lifetime is managed by reference counting, which limits the object types to those that inherit a reference count.

Source files

Definition at line 51 of file sharedRegIOobject.H.

Constructor & Destructor Documentation

◆ sharedRegIOobject() [1/3]

sharedRegIOobject
inline

Default construct.

Definition at line 32 of file sharedRegIOobjectI.H.

◆ sharedRegIOobject() [2/3]

sharedRegIOobject ( const IOobject &  io,
const Args &...  args 
)
inline

Construct from an IO object and additional arguments.

Definition at line 40 of file sharedRegIOobjectI.H.

References args, and sharedRegIOobject< Type >::set().

Here is the call graph for this function:

◆ sharedRegIOobject() [3/3]

sharedRegIOobject ( const sharedRegIOobject< Type > &  )
delete

Disallow default bitwise copy construction.

◆ ~sharedRegIOobject()

~sharedRegIOobject

Destructor.

Definition at line 55 of file sharedRegIOobjectI.H.

Member Function Documentation

◆ valid()

bool valid
inline

Is this object set?

Definition at line 62 of file sharedRegIOobjectI.H.

◆ set()

void set ( const IOobject &  io,
const Args &...  args 
)
inline

Set the object.

Definition at line 70 of file sharedRegIOobjectI.H.

Referenced by sharedRegIOobject< Type >::sharedRegIOobject().

Here is the caller graph for this function:

◆ ref()

Type & ref
inline

Return a reference to the object.

Definition at line 94 of file sharedRegIOobjectI.H.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ clear()

void clear
inline

Clear the object.

Definition at line 108 of file sharedRegIOobjectI.H.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator()()

const Type & operator()
inline

Return a reference to the object.

Definition at line 127 of file sharedRegIOobjectI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator=()

void operator= ( const sharedRegIOobject< Type > &  )
delete

Disallow default bitwise assignment.

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