SCI::sci_fir Class Reference

FIR filter - wrapper for a SIM::fir
Core function: SCI::sci_fir.proc() More...

Inheritance diagram for SCI::sci_fir:

Public Member Functions
	sci_fir ()
	~sci_fir ()
sci_fir *	create (int sci_type)
void	destroy ()
	destroy SCI object More...
void	set (int param, sci_var *p_v)
sci_var *	get (int param)
void	exec (int command)
sci_var *	proc (sci_var *p_v_ce, sci_var *p_v_x)
Public Member Functions inherited from SCI::sci_base
	sci_base ()
	constructor More...
virtual	~sci_base ()
	virtual destructor More...
sci_base *	create (int sci_type)
	creates SCI object and returns pointer to it More...
virtual sci_var *	gen (sci_var *p_v_ce)
	generate data using a SCI object More...
Public Member Functions inherited from SIM::fir
	fir ()
	~fir ()
void	set_state (const vec &v)
void	set_output (double yout)
vec	get_state (void)
double	get_output (void)
vec	process (const bvec &ce, const vec &x)

Additional Inherited Members
Public Attributes inherited from SIM::fir
double	y0
	registered filter output, initialized to 0.0 by constructor More...

Detailed Description

FIR filter - wrapper for a SIM::fir
Core function: SCI::sci_fir.proc()

Constructor & Destructor Documentation

SCI::sci_fir::sci_fir

(

)

SCI::sci_fir::~sci_fir

(

)

Member Function Documentation

sci_fir* SCI::sci_fir::create ( int  sci_type )

inline

void SCI::sci_fir::destroy ( )

inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

void SCI::sci_fir::exec ( int  command )

virtual

executes command in an object of a FIR filter

Supported commands:
SCI_RESET 

Parameters

[in]

command

- to be executed

Reimplemented from SCI::sci_base.

sci_var * SCI::sci_fir::get ( int  param )

virtual

creates new sci_var and assigns its value to the requested parameter of FIR filter

Supported parameters:
SCI_TYPE,  sci_var [int] 

SCI_SIZE,  sci_var [int] 

SCI_TAPS,  sci_var [vec] 

SCI_STATE, sci_var [vec] 

SCI_OUTPUT sci_var [double] 

Parameters

[in]

param

- parameter to get

Returns

- pointer to created sci_var

Reimplemented from SCI::sci_base.

sci_var * SCI::sci_fir::proc ( sci_var *  p_v_ce, sci_var *  p_v_x  )

virtual

creates sci_var and assigns its value to the output of SIM::fir::process()

Parameters

[in]	p_v_ce	- pointer to ce - sci_var [bvec]
[in]	p_v_x	- pointer to x - sci_var [vec]

Returns

- pointer to y - created sci_var [vec]

Reimplemented from SCI::sci_base.

void SCI::sci_fir::set ( int  param, sci_var *  p_v  )

virtual

sets parameter of a FIR filter

Supported parameters:
SCI_TAPS,   sci_var [vec]

SCI_STATE,  sci_var [vec]

SCI_OUTPUT, sci_var [double]

Parameters

[in]	param	- parameter to set
[in]	p_v	- pointer to sci_var object with value of the parameter

Reimplemented from SCI::sci_base.

---

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

• C:/jobs/vcc/itpp_sci/include/sci/sci_fir.hpp
• C:/jobs/vcc/itpp_sci/sci_lib/code/sci_fir.cpp