Loading...
Searching...
No Matches
CallbackRegistry< CallbackType > Class Template Reference

Base class with which callbacks are registered. More...

#include <CallbackRegistry.H>

Inheritance diagram for CallbackRegistry< CallbackType >:
Collaboration diagram for CallbackRegistry< CallbackType >:

Public Member Functions

 CallbackRegistry ()
 Construct null.
virtual ~CallbackRegistry ()
 Destructor.
Public Member Functions inherited from UILList< DLListBase, T >
 UILList ()=default
 Default construct.
 UILList (T *item)
 Construct and add initial item pointer.
 UILList (const UILList< DLListBase, T > &list)
 Construct as copy.
Tfront ()
 The first entry in the list.
const Tfront () const
 The first entry in the list (const access).
Tback ()
 The last entry in the list.
const Tback () const
 The last entry in the list (const access).
TremoveHead ()
 Remove and return head.
Tremove (T *item)
 Remove and return element.
Tremove (iterator &iter)
 Remove and return item specified by iterator.
void operator= (const UILList< DLListBase, T > &lst)
 Copy assignment.
bool operator== (const UILList< DLListBase, T > &lst) const
 Equality. True both lists are element-wise equal.
bool operator!= (const UILList< DLListBase, T > &lst) const
 The opposite of the equality operation. Takes linear time.
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write UILList with line-breaks when length exceeds shortLen.
iterator begin ()
 Iterator to first item in list with non-const access.
const_iterator cbegin () const
 Iterator to first item in list with const access.
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access.
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access.
const_iterator begin () const
 Iterator to first item in list with const access.
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access.
const iterator & end ()
 End of list for forward iterators.
const const_iterator & cend () const
 End of list for forward iterators.
const reverse_iterator & rend ()
 End of list for reverse iterators.
const const_reverse_iterator & crend () const
 End of list for reverse iterators.
const const_iterator & end () const
 End of list for forward iterators.
const const_reverse_iterator & rend () const
 End of list for reverse iterators.
Tfirst ()
 The first entry in the list.
const Tfirst () const
 The first entry in the list (const access).
Tlast ()
 The last entry in the list.
const Tlast () const
 The last entry in the list (const access).
Public Member Functions inherited from DLListBase
 DLListBase ()=default
 Default construct.
 DLListBase (const DLListBase &)=delete
 No copy construct.
void operator= (const DLListBase &)=delete
 No copy assignment.
 ~DLListBase ()=default
 Destructor.
bool empty () const noexcept
 True if the list is empty.
label size () const noexcept
 The number of elements in list.
linkfront ()
 Return first entry.
const linkfront () const
 Return const access to first entry.
linkback ()
 Return last entry.
const linkback () const
 Return const access to last entry.
void push_front (link *item)
 Add at front of list.
void push_back (link *item)
 Add at back of list.
bool swapUp (link *item)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *item)
 Swap this element with the one below unless it is at the bottom.
linkremoveHead ()
 Remove and return first entry.
linkremove (link *item)
 Remove and return element.
linkremove (iterator &iter)
 Remove and return element specified by iterator.
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
linkreplace (iterator &oldIter, link *newitem)
 Replace oldIter with newItem and return element.
void clear ()
 Clear the list.
void swap (DLListBase &lst)
 Swap the contents of the list.
void transfer (DLListBase &lst)
 Transfer the contents of the argument into this list and annul the argument list.
iterator begin ()
 Iterator to first item in list with non-const access.
const_iterator cbegin () const
 Iterator to first item in list with const access.
const_iterator crbegin () const
 Iterator to last item in list with const access.
const iteratorend ()
 End of list for iterators.
const const_iteratorcend () const
 End of list for iterators.
const const_iteratorcrend () const
 End of list for reverse iterators.
linkfirst ()
 Return first entry.
const linkfirst () const
 Return const access to first entry.
linklast ()
 Return last entry.
const linklast () const
 Return const access to last entry.
void prepend (link *item)
 Add at front of list.
void append (link *item)
 Add at back of list.

Additional Inherited Members

Public Types inherited from UILList< DLListBase, T >
typedef T value_type
 Type of values stored.
typedef Tpointer
 Pointer for value_type.
typedef const Tconst_pointer
 Const pointer for value_type.
typedef Treference
 Reference for value_type.
typedef const Tconst_reference
 Const reference for value_type.
typedef label size_type
 The type that can represent the container size.
typedef label difference_type
 The difference between iterator objects.
using base_iterator
using const_base_iterator
Protected Member Functions inherited from DLListBase
template<class IteratorType>
IteratorType iterator_first () const
 Return iterator to first item or end-iterator if list is empty.
template<class IteratorType>
IteratorType iterator_last () const
 Return iterator to last item or end-iterator if list is empty.
Static Protected Member Functions inherited from DLListBase
template<class IteratorType>
static const IteratorType & iterator_end ()
 Factory method to return an iterator end.
template<class IteratorType>
static const IteratorType & iterator_rend ()
 Factory method to return an iterator reverse end.

Detailed Description

template<class CallbackType>
class Foam::CallbackRegistry< CallbackType >

Base class with which callbacks are registered.

Derive from this class and extend by adding the appropriate callback functions that loop and call the callback functions for each entry.

Source files

Definition at line 64 of file CallbackRegistry.H.

Constructor & Destructor Documentation

◆ CallbackRegistry()

template<class CallbackType>
CallbackRegistry ( )

Construct null.

Definition at line 27 of file CallbackRegistry.C.

◆ ~CallbackRegistry()

template<class CallbackType>
~CallbackRegistry ( )
virtual

Destructor.

Definition at line 37 of file CallbackRegistry.C.

References forAllIters.


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