gain stage - wrapper for a SIM::amp
Core function: SCI::sci_amp.proc()
More...

Inheritance diagram for SCI::sci_amp:

Public Member Functions
	sci_amp ()

	~sci_amp ()

sci_amp *	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::amp
	amp ()

	~amp ()

void	set_gain (double g)

void	set_offset (double o)

void	set_output (double yout)

double	get_gain (void)

double	get_offset (void)

double	get_output (void)

vec	process (const bvec &ce, const vec &x)

Detailed Description

gain stage - wrapper for a SIM::amp
Core function: SCI::sci_amp.proc()

Constructor & Destructor Documentation

SCI::sci_amp::sci_amp ( )

SCI::sci_amp::~sci_amp ( )

Member Function Documentation

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

inline

void SCI::sci_amp::destroy ( )

inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

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

virtual

executes command in an object of an gain stage

Supported commands:
none

Parameters

[in] command - to be executed

Reimplemented from SCI::sci_base.

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

virtual

creates new sci_var and assigns its value to the requested parameter of a gain stage

Supported parameters:
SCI_TYPE,    sci_var [int] 

SCI_GAIN,    sci_var [double] 

SCI_OFFSET,  sci_var [double] 

SCI_OUTPUT,  sci_var [complex] output value

Parameters

[in] param - parameter to get

Returns: - pointer to created sci_var, actual object type depends on input parameter

Reimplemented from SCI::sci_base.

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

virtual

creates sci_var and assign its value to the output of a gain stage [y][vec] by processing input [x][vec] for active [ce][vec] ticks

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_amp::set	(	int	param,
		sci_var *	p_v
	)

virtual

sets parameter of an gain stage

Supported parameters:
SCI_GAIN,    sci_var [double] gain 

SCI_OFFSET,  sci_var [double] offset 

SCI_OUTPUT,  sci_var [double] output value y0

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_amp.hpp
C:/jobs/vcc/itpp_sci/sci_lib/code/sci_amp.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation