Audio Processing Framework (APF) version 0.5.0
Public Member Functions | List of all members
apf::RtList< T * >::RemCommand Class Reference

Command to remove an element from a list. More...

#include <apf/rtlist.h>

Inheritance diagram for apf::RtList< T * >::RemCommand:
Inheritance graph
[legend]

Public Member Functions

 RemCommand (list_t &dst_list, T *delinquent)
 Constructor to remove a single item. More...
 
template<typename InputIterator >
 RemCommand (list_t &dst_list, InputIterator first, InputIterator last)
 Constructor to remove a bunch of items at once. More...
 
virtual void execute ()
 The actual implementation of the command. More...
 
virtual void cleanup ()
 Cleanup of resources. More...
 
- Public Member Functions inherited from apf::CommandQueue::Command
virtual ~Command ()
 Empty virtual destructor. More...
 
virtual void execute ()=0
 The actual implementation of the command. More...
 
virtual void cleanup ()=0
 Cleanup of resources. More...
 
- Public Member Functions inherited from apf::NonCopyable
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
 NonCopyable (NonCopyable &&)=default
 
NonCopyableoperator= (NonCopyable &&)=default
 

Additional Inherited Members

- Protected Member Functions inherited from apf::NonCopyable
 NonCopyable ()=default
 Protected default constructor. More...
 
 ~NonCopyable ()=default
 Protected non-virtual destructor. More...
 

Detailed Description

template<typename T>
class apf::RtList< T * >::RemCommand

Command to remove an element from a list.

Definition at line 197 of file rtlist.h.

Constructor & Destructor Documentation

◆ RemCommand() [1/2]

template<typename T >
apf::RtList< T * >::RemCommand::RemCommand ( list_t &  dst_list,
T *  delinquent 
)
inline

Constructor to remove a single item.

Parameters
dst_listList from which the item will be removed
delinquentPointer to the item which will be removed

Definition at line 203 of file rtlist.h.

◆ RemCommand() [2/2]

template<typename T >
template<typename InputIterator >
apf::RtList< T * >::RemCommand::RemCommand ( list_t &  dst_list,
InputIterator  first,
InputIterator  last 
)
inline

Constructor to remove a bunch of items at once.

Parameters
dst_listList from which the elements will be removed
firstIterator to first item to be removed
lastPast-the-end iterator

Definition at line 213 of file rtlist.h.

Member Function Documentation

◆ execute()

template<typename T >
virtual void apf::RtList< T * >::RemCommand::execute ( )
inlinevirtual

The actual implementation of the command.

Exceptions
std::logic_errorif item(s) is/are not found

Implements apf::CommandQueue::Command.

Definition at line 220 of file rtlist.h.

◆ cleanup()

template<typename T >
virtual void apf::RtList< T * >::RemCommand::cleanup ( )
inlinevirtual

Cleanup of resources.

This is called from the non-realtime thread. Overwritten in the derived class.

Implements apf::CommandQueue::Command.

Definition at line 240 of file rtlist.h.


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