previous next Up Title Contents

Basic Module Routines used in Generic Programming


All process modules have the following routines, assessible using generic programming using the DoFun...(...) and DoProcess(...) (see Error! Reference source not found. Error! Reference source not found.):

The PrintPars Routine

Syntax
BOOLN PrintPars_...(void);


Returns
TRUE if the function is successful, otherwise it returns FALSE.


Desciption
This routine prints the parameters associated with the module.

The ReadPars Routine

Syntax
BOOLN ReadPars_...(char *fileName);


Returns
TRUE if the function is successful, otherwise it returns FALSE.


Desciption
This routine reads the parameters required by the module from a specified ASCII file. Each module has its own parameter file format, which is simply the order in which the parameter files should appear in the file.

The Process (or RunModel/Calc/GenerateSignal) Routine

Syntax
BOOLN Process_...(EarObjectPtr data);


Returns
TRUE if the process is successful, otherwise it returns FALSE.


Desciption
This routine carries out the module process, whether it be running a model, calculating an analysis result, generating a signal or carrying out some other process. (The respective name used is immaterial when Generic programming is used, because this routine is called using the DoProcess(...) command which requires only the name of the process EarObject .).

The Set... Routines

Syntax
BOOLN SetParameterName...(double theParameter);


Returns
TRUE if the function is successful, otherwise it returns FALSE.


Description
These routines set the respective module parameters. The respective parameter names are specific to each module, though some classes of modules will have similar parameters, i.e. most of the stimulus generation modules will have a SetIntensity_...(...) routine.


previous next Up Title Contents