binary circular buffer - wrapper for a SIM::binbuff
Core functions: SCI::sci_binbuff.proc(), SCI::sci_binbuff.gen()
More...

Inheritance diagram for SCI::sci_binbuff:

[legend]

Public Member Functions
	sci_binbuff ()

	~sci_binbuff ()

sci_binbuff *	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::binbuff
	binbuff ()

	~binbuff ()

void	set_size (int m)

void	set_symbol_size (int w)

void	set_output (bvec yout)

int	get_size ()

int	get_symbol_size ()

bvec	get_output ()

bmat	generate (const bvec &ce)

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

Detailed Description

binary circular buffer - wrapper for a SIM::binbuff
Core functions: SCI::sci_binbuff.proc(), SCI::sci_binbuff.gen()

Constructor & Destructor Documentation

SCI::sci_binbuff::sci_binbuff ( )

SCI::sci_binbuff::~sci_binbuff ( )

Member Function Documentation

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

inline

void SCI::sci_binbuff::destroy ( )

inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

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

virtual

executes command in an object of a SCI_BINBUFF

Supported commands:
none

Parameters

[in] command - to be executed

Reimplemented from SCI::sci_base.

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

virtual

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

Parameters

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

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

Reimplemented from SCI::sci_base.

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

virtual

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

Supported parameters:
SCI_TYPE,        sci_var [int]  

SCI_SIZE,        sci_var [int] buffer size 

SCI_SYMBOL_SIZE, sci_var [int] symbol size in bits for put()/get() in generate() and process() 

SCI_N_OF_ELEM,   sci_var [int] number of elements 

SCI_SINGLETON,   sci_var [bool] single bin value got from buffer

SCI_VEC,         sci_var [bvec] vector got from buffer

SCI_PEEK_VEC,    sci_var [bvec] vector peeked from buffer

SCI_PEEK_REV_VEC,sci_var [bvec] reversed vector peeked from buffer

SCI_OUTPUT,      sci_var [bvec] output state

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

virtual

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

Parameters

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

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

Reimplemented from SCI::sci_base.

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

virtual

sets parameters of a SCI_CIRCBUFF

Supported parameters:
SCI_SIZE,        sci_var [int] buffer size in bits

SCI_SYMBOL_SIZE, sci_var [int] symbol size in bits for put()/get() in generate() and process()

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

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

SCI_OUTPUT,      sci_var [bvec] 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_binbuff.hpp
C:/jobs/vcc/itpp_sci/sci_lib/code/sci_binbuff.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation