circular buffer - wrapper for a SIM::circbuff
Core functions: SCI::sci_cirbuff.proc(), SCI::sci_cirbuff.gen() More...

Inheritance diagram for SCI::sci_circbuff:

Public Member Functions
	sci_circbuff ()

	~sci_circbuff ()

sci_circbuff *	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)

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...

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

	~circbuff ()

void	set_size (int m)

void	set_output (double yout)

int	get_size ()

double	get_output ()

vec	generate (const bvec &ce)

vec	process (const bmat &ceio, const vec &x)

Detailed Description

circular buffer - wrapper for a SIM::circbuff
Core functions: SCI::sci_cirbuff.proc(), SCI::sci_cirbuff.gen()

Constructor & Destructor Documentation

SCI::sci_circbuff::sci_circbuff ( )

SCI::sci_circbuff::~sci_circbuff ( )

Member Function Documentation

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

inline

void SCI::sci_circbuff::destroy ( )

inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

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

virtual

executes command in an object of a SCI_CIRCBUFF

Supported commands:
none

Parameters

[in] command - to be executed

Reimplemented from SCI::sci_base.

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

virtual

creates sci_var and assigns its value to the output of SIM::circbuff::generate()

Parameters

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

Returns: - pointer to y - new sci_var [vec]

Reimplemented from SCI::sci_base.

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

virtual

creates new sci_var object and assigns its value to a parameter of the SCI_CIRCBUFF

Supported parameters:
SCI_TYPE,        sci_var [int]  

SCI_SIZE,        sci_var [int] buffer size 

SCI_N_OF_ELEM,   sci_var [int] number of elements 

SCI_SINGLETON,   sci_var [double] single value got from buffer

SCI_VEC,         sci_var [vec] vector got from buffer

SCI_PEEK_VEC,    sci_var [vec] vector peeked from buffer

SCI_PEEK_REV_VEC,sci_var [vec] reversed vector peeked from buffer

SCI_OUTPUT,      sci_var [double] output

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_circbuff::proc	(	sci_var *	p_v_ce,
		sci_var *	p_v_x
	)

virtual

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

Parameters

[in]	p_v_ce	- pointer to ce - sci_var [bmat][cei\|ceo]
[in]	p_v_x	- pointer to x - sci_var [vec]

Returns: - pointer to y - new sci_var [vec]

Reimplemented from SCI::sci_base.

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

virtual

sets parameters of a SCI_CIRCBUFF

Supported parameters:
SCI_SIZE,      sci_var [int] buffer size

SCI_SINGLETON, sci_var [double] single value to be put into buffer

SCI_VEC,       sci_var [vec] vector to be put into buffer

SCI_OUTPUT,    sci_var [double] output state

Parameters

[in]	param	- parameter to set
[in]	p_v	- pointer to sci_var object with the 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_circbuff.hpp
C:/jobs/vcc/itpp_sci/sci_lib/code/sci_circbuff.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation