previous next Up Title Contents

Utility_SimulationSpec: Simulation Specification Interface


File name
UtSimSpec.[ch]


Description
This module is used for running simulation processes using the simulation specification programming modesee 0 Simulation Specification Programming (AudPerSS.c).

The ramp rise time parameter (rampInterval) is only used at the start of a simulation specification if a ramp has not been previously applied, i.e. the signal's rampFlag has not been setsee Error! Reference source not found. Error! Reference source not found..

When the diagnostics mode is "ON", each time the simulation specification is executed, the process diagnostics will be printed out.



Example parameter file format
# Misc. parameters.
on	Diagnostics mode ("OFF" or "ON").
2.5e-3	Ramp rise time for stimuli (s)

# Module Specifications

begin {

	Harmonic 			< Harmonic2.par
	Utility_SimulationSpec		< SimSpec2.par
	reset	fibres
	repeat 500 {
		ANSpikeGen_Simple		< SpikeGen1.par
		fibres% Utility_Accumulate
	}
	Analysis_ACF		< AutoCorr2.par
	Display_Signal		< Display1.par

}



Test program directory
Tests/Utilities

Generic Module Routines

This module has the standard Generic Module Routines (see 0 Basic Module Routines used in Generic Programming). Only the module routines accessible from the generic programming interface are listed here. The other module routines may be found in section Error! Reference source not found. Error! Reference source not found..

The Process_Utility_SimulationSpec(...) Process Routine

Syntax
BOOLN Process_Utility_SimulationSpec(EarObjectPtr data);


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

The SetMode_Utility_SimulationSpec(...) Routine

Syntax
BOOLN SetMode_Utility_SimulationSpec(char *theMode);


Special Values
Diagnostic mode options: "ON" or "OFF". . This option decides whether the process diagnostics are printed each time the simulation specification is run.


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

The SetPars_Utility_SimulationSpec(...) Routine

Syntax
BOOLN SetPars_Utility_SimulationSpec(Datum *simulation, char *mode, double rampInterval);


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

The SetRampInterval_Utility_SimulationSpec(...) Routine

Syntax
BOOLN SetRampInterval_Utility_SimulationSpec(double theRampInterval);


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

The SetSimulation_Utility_SimulationSpec(...) Routine

Syntax
BOOLN SetSimulation_Utility_SimulationSpec(Datum *theSimulation);


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

Example: Tests/Utilities/SimulationSpec.c

Parameter file: SimulationSpec.par:
#
# Main Parameter file
#

output.dat	Name of output file.

# Module specifications.

#Par. file		Name			Description
#---------		-----			-------------
Hrmonic1.par		null			Pre-Process module.
StepFun1.par		null			Post-Process module.

SimSpec1.par	Simulation specification utility module parameter file.

# Miscellaneous parameters

2		Number of repeated runs.
2.5e-3	Ramp up rise time for signal (s).
Output

Figure [163] Output using the "SimulationSpec" utility module.


previous next Up Title Contents