SoftFilters  0.1.0
Arduino framework and library of software data filters.
FilterChain Class Reference

A chain of filters. More...

#include <framework.h>

Inheritance diagram for FilterChain:
Collaboration diagram for FilterChain:

Protected Member Functions

virtual void const *const get_output_val_ptr () final
 Read-only access to the internal output memory. More...
 
virtual bool update (void const *const input) final
 Internally update the filter output based on the given input. More...
 
virtual void copy_to_client (void *const output) final
 Copy the output to client memory.
 

Private Attributes

LinkedList< Filter * >::iterator it
 
LinkedList< Filter * >::iterator prev
 

Additional Inherited Members

- Public Types inherited from LinkedList< Filter *>
typedef NodeIterator< Filter * > iterator
 
- Public Member Functions inherited from LinkedList< Filter *>
void append (Filter * const &v)
 Append an element. More...
 
bool isEmpty ()
 Tell whether the linked list is empty.
 
NodeIterator< Filter * > begin ()
 An iterator pointing at the beginning of the linked list. More...
 
NodeIterator< Filter * > end ()
 An iterator pointing at the end of the linked list. More...
 
NodeIterator< Filter * > last ()
 An iterator pointing at the last node.
 
- Public Member Functions inherited from Filter
bool push (void const *const input, void *const output)
 Push a new data through the filter. More...
 

Detailed Description

A chain of filters.

Member Function Documentation

◆ get_output_val_ptr()

virtual void const* const FilterChain::get_output_val_ptr ( )
inlinefinalprotectedvirtual

Read-only access to the internal output memory.

This member function is mainly used by derived composite filters, which needs to point the output of the previous filter stage to the input of the next fitler stage. See for example the implementation of FilterChain.

Returns
A read-only pointer to the memory where the output value is stored internally by the filter.

Implements Filter.

◆ update()

virtual bool FilterChain::update ( void const *const  input)
inlinefinalprotectedvirtual

Internally update the filter output based on the given input.

This method behaves similarly to the public Filter::push method, but without copying the output to the client memory. This method is for internal workings of the filter framework.

Implements Filter.


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