white gaussian noise - wrapper for a SIM::wgn
Core function: SCI::sci_wgn.gen() More...

Inheritance diagram for SCI::sci_wgn:

Public Member Functions
	sci_wgn ()

	~sci_wgn ()

sci_wgn *	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 *	gen (sci_var *p_v_ce)

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 *	proc (sci_var p_v_ce, sci_var p_v_x)
	process data using a SCI object More...

Public Member Functions inherited from SIM::wgn
	wgn ()

	~wgn ()

void	set_sigma (double s)

void	set_mean (double m)

void	set_output (double yout)

double	get_sigma (void)

double	get_mean (void)

double	get_output (void)

vec	generate (const bvec &ce)

Additional Inherited Members
Public Attributes inherited from SIM::wgn
double	y0

double	sigma

double	mean

Detailed Description

white gaussian noise - wrapper for a SIM::wgn
Core function: SCI::sci_wgn.gen()

Constructor & Destructor Documentation

SCI::sci_wgn::sci_wgn ( )

SCI::sci_wgn::~sci_wgn ( )

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

inline

void SCI::sci_wgn::destroy ( )

inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

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

virtual

execute command for an instance of a WGN generator

Supported commands: NONE

Parameters

[in] command - to be executed

Reimplemented from SCI::sci_base.

sci_var * SCI::sci_wgn::gen ( sci_var * p_v_ce )

virtual

for active [ce] ticks, assign output to [y], newly created sci_var [vec]

Parameters

[in] p_v_ce - pointer to ce - sci_var [bvec]

Reimplemented from SCI::sci_base.

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

virtual

create new sci_var object and assign its value to WGN generator parameter - param

Supported parameters:
SCI_TYPE,    sci_var [int] 

SCI_SIGMA,    sci_var [double]

SCI_MEAN,    sci_var [double]

SCI_OUTPUT,   sci_var [double]

Parameters

[in] param - parameter to get

Reimplemented from SCI::sci_base.

virtual

set parameters of a WGN generator

Supported parameters:
SCI_SIGMA,    sci_var [double]

SCI_MEAN,    sci_var [double]

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: