Public Member Functions | List of all members
Callback< CallbackType > Class Template Reference

Abstract class to handle automatic call-back registration with the CallbackRegistry. Derive from this class and extend by adding the appropriate callback functions. More...

Inheritance diagram for Callback< CallbackType >:
Inheritance graph
[legend]
Collaboration diagram for Callback< CallbackType >:
Collaboration graph
[legend]

Public Member Functions

 Callback (CallbackRegistry< CallbackType > &)
 Construct and register with CallbackRegistry. More...
 
 Callback (const Callback< CallbackType > &)
 Construct as copy. More...
 
virtual ~Callback ()
 Destructor. More...
 
bool checkIn ()
 Register Callback with CallbackRegistry. More...
 
bool checkOut ()
 Check-out Callback from CallbackRegistry. More...
 

Detailed Description

template<class CallbackType>
class Foam::Callback< CallbackType >

Abstract class to handle automatic call-back registration with the CallbackRegistry. Derive from this class and extend by adding the appropriate callback functions.

Source files

Definition at line 51 of file Callback.H.

Constructor & Destructor Documentation

◆ Callback() [1/2]

Callback ( CallbackRegistry< CallbackType > &  cbr)

Construct and register with CallbackRegistry.

Definition at line 31 of file Callback.C.

References Callback< CallbackType >::checkIn().

Here is the call graph for this function:

◆ Callback() [2/2]

Callback ( const Callback< CallbackType > &  cb)

Construct as copy.

Definition at line 40 of file Callback.C.

References Callback< CallbackType >::checkIn().

Here is the call graph for this function:

◆ ~Callback()

~Callback ( )
virtual

Destructor.

Definition at line 51 of file Callback.C.

References Callback< CallbackType >::checkOut().

Here is the call graph for this function:

Member Function Documentation

◆ checkIn()

bool checkIn ( )

Register Callback with CallbackRegistry.

Definition at line 60 of file Callback.C.

Referenced by Callback< CallbackType >::Callback().

Here is the caller graph for this function:

◆ checkOut()

bool checkOut ( )

Check-out Callback from CallbackRegistry.

Definition at line 75 of file Callback.C.

Referenced by Callback< CallbackType >::~Callback().

Here is the caller graph for this function:

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