mf::flow::filter Class Reference

Filter which performs concrete processing, base class. More...

#include <filter.h>

Inheritance diagram for mf::flow::filter:

Public Types
template<std::size_t Dim, typename Elem >
using	input_type = input_port< Dim, Elem >
template<std::size_t Dim, typename Elem >
using	output_type = output_port< Dim, Elem >
template<typename Value >
using	parameter_type = filter_parameter< Value >

Public Member Functions
	filter (filter_node &nd)
	filter (const filter &)=delete
filter &	operator= (const filter &)=delete
filter_node &	this_node () noexcept
const filter_node &	this_node () const noexcept
bool	reached_end () const
virtual	~filter ()
virtual void	setup ()
	Set up the filter, called prior to any frame being processed. More...
virtual void	pre_process (node_job &)
	Prepare for processing a frame. More...
virtual void	process (node_job &)=0
	Process a frame. More...

Detailed Description

Filter which performs concrete processing, base class.

Concrete filters are implemented as classes derived from filter, source_filter or sink_filter.

Member Typedef Documentation

template<std::size_t Dim, typename Elem >

using mf::flow::filter::input_type = input_port<Dim, Elem>

template<std::size_t Dim, typename Elem >

using mf::flow::filter::output_type = output_port<Dim, Elem>

template<typename Value >

using mf::flow::filter::parameter_type = filter_parameter<Value>

Constructor & Destructor Documentation

mf::flow::filter::filter ( filter_node &  nd )

inlineexplicit

mf::flow::filter::filter ( const filter &  )

delete

virtual mf::flow::filter::~filter ( )

inlinevirtual

Member Function Documentation

filter& mf::flow::filter::operator= ( const filter &  )

delete

virtual void mf::flow::filter::pre_process ( node_job &  )

inlinevirtual

Prepare for processing a frame.

Reimplemented in mf::flow::importer_filter< Importer, std::enable_if_t< Importer::is_seekable > >.

virtual void mf::flow::filter::process ( node_job &  )

pure virtual

Process a frame.

Implemented in mf::flow::importer_filter< Importer, std::enable_if_t< Importer::is_seekable > >, mf::flow::importer_filter< Importer, typename >, mf::flow::exporter_filter< Exporter >, and mf::flow::color_converter_filter< Input_color, Output_color >.

bool mf::flow::filter::reached_end ( ) const

inline

virtual void mf::flow::filter::setup ( )

inlinevirtual

Set up the filter, called prior to any frame being processed.

Reimplemented in mf::flow::importer_filter< Importer, std::enable_if_t< Importer::is_seekable > >, mf::flow::importer_filter< Importer, typename >, mf::flow::exporter_filter< Exporter >, and mf::flow::color_converter_filter< Input_color, Output_color >.

filter_node& mf::flow::filter::this_node ( )

inlinenoexcept

const filter_node& mf::flow::filter::this_node ( ) const

inlinenoexcept

---

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

• src/filter/filter.h