ForSyDe::DDE::filter< T > Class Template Reference

Process constructor for implementing a linear filter. More...

#include <dde_process_constructors.hpp>

Inheritance diagram for ForSyDe::DDE::filter< T >:
Collaboration diagram for ForSyDe::DDE::filter< T >:

Public Types

typedef matrix< T > MatrixDouble
 

Public Member Functions

 filter (sc_module_name _name, std::vector< T > numerators, std::vector< T > denominators, sc_time max_step, sc_time min_step=sc_time(0.05, SC_NS), T tol_error=1e-5)
 The constructor requires the module name. More...
 
std::string forsyde_kind () const
 Specifying from which process constructor is the module built.
 
- Public Member Functions inherited from ForSyDe::process
 process (sc_module_name _name)
 The constructor requires the module name. More...
 

Public Attributes

DDE_in< T > iport1
 port for the input channel
 
DDE_out< T > oport1
 port for the output channel
 
DDE_out< unsigned int > oport2
 port for the sampling signal
 

Additional Inherited Members

- Protected Member Functions inherited from ForSyDe::process
void end_of_simulation ()
 This hook is used to run the clean stage.
 

Detailed Description

template<class T>
class ForSyDe::DDE::filter< T >

Process constructor for implementing a linear filter.

This class is used to build a process which implements a linear filter based on the numerator and denominator constants.

Constructor & Destructor Documentation

template<class T>
ForSyDe::DDE::filter< T >::filter ( sc_module_name  _name,
std::vector< T >  numerators,
std::vector< T >  denominators,
sc_time  max_step,
sc_time  min_step = sc_time(0.05,SC_NS),
tol_error = 1e-5 
)
inline

The constructor requires the module name.

It creates an SC_THREAD which inserts the initial element, reads data from its input port, and writes the results using the output port.

Parameters
_nameprocess name
numeratorsNumerator constants
denominatorsDenominator constants
max_stepMaximum time step
min_stepMinimum time step
tol_errorTolerated error

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