Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

FEAPI_ParameterDescription_t_tag Struct Reference
[Interface Structures and Types]

#include <FEAPI.h>


Detailed Description

Structure describing properties and other information about one parameter.

Definition at line 153 of file FEAPI.h.

Data Fields

char acName [FEAPI_kMaxNameLength]
 name of the parameter (e.g. "Gain", "Sensitivity", etc.)
char acUnit [FEAPI_kMaxUnitLength]
 unit of the parameter (e.g. "dB", "Hz", etc.)
char acDescription [FEAPI_kMaxDescriptionLength]
 description of the parameter (clear text description)
float fRangeMin
 minimum value of the parameter (if no minimum value: minimum floating point value)
float fRangeMax
 maximum value of the parameter (if no maximum value: maximum floating point value)
float fDefaultValue
 default value for the parameter
float fQuantizedTo
 quantization step size of the parameter (e.g. 1 for integer quantization, -1 for no quantization)
int bIsChangeableInRealTime
 0/false if the parameter has to be set before the processing starts and can not be changed during processing, 1 if the parameter can be changed during processing (*NOTE: you have to call initialize after changing a non-realtime parameter*)


Field Documentation

char FEAPI_ParameterDescription_t_tag::acDescription[FEAPI_kMaxDescriptionLength]
 

description of the parameter (clear text description)

Definition at line 157 of file FEAPI.h.

char FEAPI_ParameterDescription_t_tag::acName[FEAPI_kMaxNameLength]
 

name of the parameter (e.g. "Gain", "Sensitivity", etc.)

Definition at line 155 of file FEAPI.h.

char FEAPI_ParameterDescription_t_tag::acUnit[FEAPI_kMaxUnitLength]
 

unit of the parameter (e.g. "dB", "Hz", etc.)

Definition at line 156 of file FEAPI.h.

int FEAPI_ParameterDescription_t_tag::bIsChangeableInRealTime
 

0/false if the parameter has to be set before the processing starts and can not be changed during processing, 1 if the parameter can be changed during processing (*NOTE: you have to call initialize after changing a non-realtime parameter*)

Definition at line 162 of file FEAPI.h.

float FEAPI_ParameterDescription_t_tag::fDefaultValue
 

default value for the parameter

Definition at line 159 of file FEAPI.h.

float FEAPI_ParameterDescription_t_tag::fQuantizedTo
 

quantization step size of the parameter (e.g. 1 for integer quantization, -1 for no quantization)

Definition at line 161 of file FEAPI.h.

float FEAPI_ParameterDescription_t_tag::fRangeMax
 

maximum value of the parameter (if no maximum value: maximum floating point value)

Definition at line 159 of file FEAPI.h.

float FEAPI_ParameterDescription_t_tag::fRangeMin
 

minimum value of the parameter (if no minimum value: minimum floating point value)

Definition at line 159 of file FEAPI.h.


The documentation for this struct was generated from the following file:
Generated on Fri Mar 23 10:28:52 2007 for FEAPI Documentation by  doxygen 1.3.9.1