virtual base class SCI_API API functions More...

Inheritance diagram for SCI::sci_base:

[legend]

Public Member Functions
	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 void	destroy ()
	destroy SCI object More...

virtual void	set (int param, sci_var *p_v)
	set parameters of the SCI object More...

virtual sci_var *	get (int param)
	get parameters of the SCI object More...

virtual void	exec (int command)
	execute command for a SCI object More...

virtual sci_var *	gen (sci_var *p_v_ce)
	generate data using a SCI object More...

virtual sci_var *	proc (sci_var p_v_ce, sci_var p_v_x)
	process data using a SCI object More...

Detailed Description

virtual base class SCI_API API functions

sci_create()
sci_set()
sci_get()
sci_exec()
sci_gen()
sci_proc()
sci_destroy()

Virtual functions are for getting functions of derived class through the pointers of the base class
input parameters are defined by pointer to sci_var objects
returned pointers to sci_var objects points to newly created sci_var objects

Note: when function returns a pointer - this indicates that an new() object was created,
and it should be deleted at some point by application to avoid memory leaks

Constructor & Destructor Documentation

SCI::sci_base::sci_base ( )

inline

constructor

virtual SCI::sci_base::~sci_base ( )

inlinevirtual

virtual destructor

Member Function Documentation

sci_base * sci_base::create ( int sci_type )

creates SCI object and returns pointer to it

virtual void SCI::sci_base::destroy ( )

inlinevirtual

virtual void SCI::sci_base::exec ( int command )

inlinevirtual

execute command for a SCI object

Parameters

command - type of command to execute

Reimplemented in SCI::sci_rms, SCI::sci_wgn, SCI::sci_amp, SCI::sci_circbuff, SCI::sci_fir, SCI::sci_lfsr, SCI::sci_int2bin, SCI::sci_tedg_x, SCI::sci_circbuff_x, SCI::sci_ejp, SCI::sci_qam_mod, SCI::sci_amp_x, SCI::sci_binbuff, SCI::sci_cofdm_mod, SCI::sci_fir_up, SCI::sci_mix, SCI::sci_rms_x, SCI::sci_ap2iq, SCI::sci_bin2int, SCI::sci_casdec_x, SCI::sci_cofdm_demap, SCI::sci_cofdm_map, SCI::sci_cofdm_sel, SCI::sci_counter, SCI::sci_fir_x, SCI::sci_iq2ap, SCI::sci_mix_x, SCI::sci_nco, SCI::sci_pam_mod, SCI::sci_src, SCI::sci_vco, SCI::sci_wgn_x, SCI::sci_cofdm_dem, SCI::sci_fir_up_x, SCI::sci_lsr, SCI::sci_src_x, SCI::sci_bert, SCI::sci_pam_dem, SCI::sci_psk_dem, SCI::sci_psk_mod, and SCI::sci_qam_dem.

virtual sci_var* SCI::sci_base::gen ( sci_var * p_v_ce )

inlinevirtual

generate data using a SCI object

Parameters

p_v_ce - pointer to sci_var with ce[] clock enable signal

Returns: - pointer to sci_var object with generated values

Reimplemented in SCI::sci_wgn, SCI::sci_circbuff, SCI::sci_lfsr, SCI::sci_circbuff_x, SCI::sci_binbuff, SCI::sci_counter, and SCI::sci_wgn_x.

virtual sci_var* SCI::sci_base::get ( int param )

inlinevirtual

get parameters of the SCI object

Parameters

param - type of parameter to get

Returns: - pointer to sci_var object with parameters value

Reimplemented in SCI::sci_rms, SCI::sci_wgn, SCI::sci_amp, SCI::sci_circbuff, SCI::sci_fir, SCI::sci_lfsr, SCI::sci_int2bin, SCI::sci_tedg_x, SCI::sci_circbuff_x, SCI::sci_ejp, SCI::sci_qam_mod, SCI::sci_amp_x, SCI::sci_binbuff, SCI::sci_cofdm_mod, SCI::sci_fir_up, SCI::sci_mix, SCI::sci_rms_x, SCI::sci_ap2iq, SCI::sci_bin2int, SCI::sci_casdec_x, SCI::sci_cofdm_demap, SCI::sci_cofdm_map, SCI::sci_cofdm_sel, SCI::sci_counter, SCI::sci_fir_x, SCI::sci_iq2ap, SCI::sci_mix_x, SCI::sci_nco, SCI::sci_pam_mod, SCI::sci_src, SCI::sci_vco, SCI::sci_wgn_x, SCI::sci_cofdm_dem, SCI::sci_fir_up_x, SCI::sci_lsr, SCI::sci_src_x, SCI::sci_bert, SCI::sci_pam_dem, SCI::sci_psk_dem, SCI::sci_psk_mod, and SCI::sci_qam_dem.

virtual sci_var* SCI::sci_base::proc	(	sci_var *	p_v_ce,
		sci_var *	p_v_x
	)

inlinevirtual

process data using a SCI object

Parameters

p_v_ce	- pointer to sci_var with ce[] clock enable signal
p_v_x	- pointer to sci_var with x[] input signal

Returns: - pointer to sci_var object with output values

Reimplemented in SCI::sci_circbuff, SCI::sci_rms, SCI::sci_amp, SCI::sci_fir, SCI::sci_circbuff_x, SCI::sci_int2bin, SCI::sci_tedg_x, SCI::sci_binbuff, SCI::sci_ejp, SCI::sci_qam_mod, SCI::sci_amp_x, SCI::sci_cofdm_mod, SCI::sci_fir_up, SCI::sci_mix, SCI::sci_rms_x, SCI::sci_ap2iq, SCI::sci_bin2int, SCI::sci_casdec_x, SCI::sci_cofdm_demap, SCI::sci_cofdm_map, SCI::sci_cofdm_sel, SCI::sci_fir_x, SCI::sci_iq2ap, SCI::sci_mix_x, SCI::sci_nco, SCI::sci_pam_mod, SCI::sci_src, SCI::sci_vco, SCI::sci_cofdm_dem, SCI::sci_fir_up_x, SCI::sci_lsr, SCI::sci_src_x, SCI::sci_bert, SCI::sci_pam_dem, SCI::sci_psk_dem, SCI::sci_psk_mod, and SCI::sci_qam_dem.

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

inlinevirtual

set parameters of the SCI object

Parameters

param	- type of parameter to set
p_v	- pointer to sci_var object with parameters value

Reimplemented in SCI::sci_rms, SCI::sci_wgn, SCI::sci_amp, SCI::sci_circbuff, SCI::sci_fir, SCI::sci_lfsr, SCI::sci_int2bin, SCI::sci_tedg_x, SCI::sci_circbuff_x, SCI::sci_ejp, SCI::sci_qam_mod, SCI::sci_amp_x, SCI::sci_binbuff, SCI::sci_cofdm_mod, SCI::sci_fir_up, SCI::sci_mix, SCI::sci_rms_x, SCI::sci_ap2iq, SCI::sci_bin2int, SCI::sci_casdec_x, SCI::sci_cofdm_demap, SCI::sci_cofdm_map, SCI::sci_cofdm_sel, SCI::sci_counter, SCI::sci_fir_x, SCI::sci_iq2ap, SCI::sci_mix_x, SCI::sci_nco, SCI::sci_pam_mod, SCI::sci_src, SCI::sci_vco, SCI::sci_wgn_x, SCI::sci_cofdm_dem, SCI::sci_fir_up_x, SCI::sci_lsr, SCI::sci_src_x, SCI::sci_bert, SCI::sci_pam_dem, SCI::sci_psk_dem, SCI::sci_psk_mod, and SCI::sci_qam_dem.

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

C:/jobs/vcc/itpp_sci/include/sci/_sci_base.hpp
C:/jobs/vcc/itpp_sci/common/_sci_api.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation