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

RMS measurment block - wrapper for a SIM::rms
Core function: SCI::sci_rms.proc() More...

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

Public Member Functions

 sci_rms ()
 
 ~sci_rms ()
 
sci_rmscreate (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::rms
 rms ()
 
 ~rms ()
 
void set_size (int n)
 
void set_output (double yout)
 
int get_size (void)
 
double get_output (void)
 
vec process (const bvec &ce, const vec &x)
 

Detailed Description

RMS measurment block - wrapper for a SIM::rms
Core function: SCI::sci_rms.proc()

Constructor & Destructor Documentation

SCI::sci_rms::sci_rms ( )
SCI::sci_rms::~sci_rms ( )

Member Function Documentation

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

destroy SCI object

Reimplemented from SCI::sci_base.

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

execute command for an instance of a RMS processor

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

Reimplemented from SCI::sci_base.

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

create new sci_var object and assign its value to RMS processor parameter - param

Supported parameters:
SCI_TYPE,    sci_var [int] 
SCI_SIZE, sci_var [int]
SCI_OUTPUT, sci_var [double]
Parameters
[in]param- parameter to get
Returns
- pointer to created sci_var

Reimplemented from SCI::sci_base.

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

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

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

Reimplemented from SCI::sci_base.

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

set parameters of a RMS processor

Supported parameters:
SCI_SIZE,    sci_var [int]
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: