Syntax
|
BOOLN ConnectOutSignalToIn_EarObject(EarObjectPtr
supplier, EarObjectPtr customer);
|
| Description
|
This
routine connects the output signal of the supplier to the input signal
of the customer. It does this by merely putting the customer into the
supplier's customer list, and adding the supplier to the customer's supplier
list.
This routine tests for NULL EarObjects
|
| Returns
|
TRUE
if this function succeeeds, otherwise it returns FALSE.
|
| Example(s)
|
most
test programs.
|
Syntax
|
void Free_EarObject(EarObjectPtr *theObject);
|
| Description
|
This
routine ensures that all pointers of theObject have their memory
released before memory of the object itself is released. Only locally create
signals will be free'd, i.e. each EarObject must release the signals which it
created. It also sets the pointer, theObject to NULL, hence the address
of the pointer is passed to this function.
|
| Returns
|
none.
|
| Example(s)
|
FreeAll_EarObject()
routine.
|
| Syntax
|
void FreeAll_EarObject(void);
|
| Description
|
This
routine frees the memory for all of the initialised EarObjects from the main
register list. It does not, however, set the pointer variables to NULL - watch
this.
|
| Returns
|
none.
|
| Example(s)
|
all
test routines.
|
| Syntax
|
double GetResult_EarObject(EarObjectPtr data,
uShort channel)
|
| Description
|
This
routine returns sample 0 from a specified EarObject output signal
channel. It is expected that it will be mostly used to return results from the
analysis modules.
|
| Returns
|
A
sample value.
|
| Example(s)
|
Tests/Combinations/StimulusResp.c
|
| Syntax
|
double GetSample_EarObject(EarObjectPtr data,
uShort channel, ChanLen sample)
|
| Description
|
This
routine returns a sample from an EarObject output signal channel.
|
| Returns
|
A
sample value.
|
| Example(s)
|
Tests/Models/Transduction/ACDCRatio.c
|
| Syntax
|
EarObjectPtr Init_EarObject(char
*moduleName);
|
| Description
|
This
routine takes care of the correct initialisation of an EarObject data
structure: input and output signals are set to NULL, as required later, etc.
The moduleName is used to initialise the process to be associated with
the EarObject. The module name "Null" if no process association is
required. This routine is a special case of the Error! Reference source not found. Error! Reference source not found..
All initialised EarObjects are registered in the main list.
|
| Returns
|
A
pointer to the EarObject or NULL if it fails.
|
| Example(s)
|
most
test programs.
|
| Syntax
|
EarObjectPtr Init_EarObject_MultiInput(char
*moduleName, int maxInSignals)
|
| Description
|
This
routine takes care of the correct initialisation of an EarObject data
structure: input and output signals are set to NULL, as required later, etc.
The moduleName is used to initialise the process to be associated with
the EarObject. The module name "Null" if no process association is
required. Process EarObjects initialised using this routine can be connected to more than one supplier process EarObject..
All initialised EarObjects are registered in the main list.
|
| Returns
|
A
pointer to the EarObject or NULL if it fails.
|
| Example(s)
|
Tests/Utilities/CreateBinaural.c
|
| Syntax
|
void ResetProcess_EarObject(EarObjectPtr
theObject)
|
| Description
|
This
routine resets an EarObject's process by setting the
updateProcessFlag to "TRUE".
This facility is used by process modules which accumulate output over repeated
runs.
|
| Returns
|
None.
|
| Example(s)
|
Tests/Utilities/Accumulate.c
|
| Syntax
|
void
PrintProcessName_EarObject(char *message, EarObjectPtr data);
|
Description
|
This
routine outputs the data EarObject's process name to the standard
output, provided that it has been set, otherwise it will output "<no name
set>". The message string should be in the form "text....%s.....more
text (if required).".
It assumes that all EarObjects are initialised to NULL when declared.
|
| Returns
|
none.
|
| Example(s)
|
most
test programs.
|