itpp_sci  1.0.0
it++ based simulation framework for scicoslab, scilab and scipy
Public Member Functions | List of all members
SCI::sci_mix Class Reference

mixer - wrapper for a SIM::mix
Core function: SCI::sci_mix.proc() More...

Inheritance diagram for SCI::sci_mix:
Inheritance graph
[legend]

Public Member Functions

 sci_mix ()
 
 ~sci_mix ()
 
sci_mixcreate (int sci_type)
 
void destroy ()
 destroy SCI object More...
 
void set (int param, sci_var *p_v)
 
sci_varget (int param)
 
void exec (int command)
 
sci_varproc (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_basecreate (int sci_type)
 creates SCI object and returns pointer to it More...
 
virtual sci_vargen (sci_var *p_v_ce)
 generate data using a SCI object More...
 
- Public Member Functions inherited from SIM::mix
 mix ()
 
 ~mix ()
 
void set_output (double yout)
 
double get_output (void)
 
vec process (const bvec &ce, const mat &x)
 

Additional Inherited Members

- Public Attributes inherited from SIM::mix
double y0
 

Detailed Description

mixer - wrapper for a SIM::mix
Core function: SCI::sci_mix.proc()

Constructor & Destructor Documentation

SCI::sci_mix::sci_mix ( )
SCI::sci_mix::~sci_mix ( )

Member Function Documentation

sci_mix* SCI::sci_mix::create ( int  sci_type)
inline
void SCI::sci_mix::destroy ( )
inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

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

executes command in an object of a mixer

Supported commands:
none 
Parameters
[in]command- to be executed

Reimplemented from SCI::sci_base.

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

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

Supported parameters:
SCI_TYPE,    sci_var [int] 
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_mix::proc ( sci_var p_v_ce,
sci_var p_v_x 
)
virtual

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

Parameters
[in]p_v_ce- pointer to ce - sci_var [bvec]
[in]p_v_x- pointer to x - sci_var [mat]
Returns
- pointer to y - created sci_var [vec]

Reimplemented from SCI::sci_base.

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

sets parameter of a mixer

Supported parameters:
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: