ewdb_internal_CheckidWaveform()

Prototype: |
int ewdb_internal_CheckidWaveform( | EWDBid IN_idWaveform);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_CheckidWaveform.c
Description: | Checks the DB waveform table to validate that there exists a Waveform record with the given idWaveform. Returns EWDB_RETURN_SUCCESS if a matching record is found, otherwise returns EWDB_RETURN_FAILURE.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
IN_idWaveform | EWDBid | DB ID that the caller wants validated.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_CreateSnippet()

Prototype: |
int ewdb_internal_CreateSnippet( | EWDBid IN_idWaveform, char * IN_pSnippet, int IN_SnippetSize);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_CreateSnippet.c
Description: | Inserts the binary waveform snippet into the database. A waveform descriptor must already exist in the DB for the given waveform. The idWaveform is the DB ID of the existin waveform descriptor.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
IN_idWaveform | EWDBid | Database ID of the Waveform associated with this snippet.
IN_pSnippet | char * | Pointer to the binary waveform snippet to be inserted.
IN_SnippetSize | int | Length of the snippet.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_CreateWaveformDesc()

Prototype: |
int ewdb_internal_CreateWaveformDesc( | EWDB_WaveformStruct * pWaveform, int bBindToEvent, EWDBid idEvent);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_CreateWaveformDesc.c
Description: | Insert a waveform descriptor record into the database and associate it with an Event(if bBindToEvent is set to TRUE).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
pWaveform | EWDB_WaveformStruct * | Input waveform structure filled by the caller.
bBindToEvent | int | Set to 1 if this waveform record should be bound to the event specified by idEvent.
idEvent | EWDBid | Database ID of the Event with which this Waveform Descriptor is associated.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetWaveformList()

Prototype: |
ewdb_internal_GetWaveformList( | EWDBid IN_idEvent, EWDB_WaveformStruct IN_pWaveformBuffer, int IN_BufferRecLen);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_GetWaveformList.c
Description: | The function retrieves a list of waveforms that are associated with a given event. See EWDB_WaveformStruct for a description of the information retrieved for each associated waveform.
Note: | This function only retrieves the waveform DESCRIPTORS, it does not actually retrieve the binary waveform.
RETURN CODE INFO
Return Type: |
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
IN_idEvent | EWDBid | Database ID of the Event whose waveform snippets we are interested in.
IN_pWaveformBuffer | EWDB_WaveformStruct | Pointer to a pre-allocated array of waveform structs which will be filled by this function.
IN_BufferRecLen | int | Length of the IN_pWaveformBuffer array.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetWaveformListWithCompT()

Prototype: |
int ewdb_internal_GetWaveformListWithCompT( | EWDBid IN_idEvent, EWDB_WaveformStruct IN_pWaveformBuffer, EWDB_StationStruct IN_pStationBuffer, int IN_BufferRecLen);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_GetWaveformListWithCompT.c
Description: | The function retrieves a list of waveforms (and their associated station/component info) that are associated with a given event. See EWDB_WaveformStruct and EWDB_StationStruct for a description of the information retrieved for each associated waveform.
Note: | This function only retrieves the waveform DESCRIPTORS, it does not actually retrieve the binary waveform.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
IN_idEvent | EWDBid | Database ID of the Event whose waveform snippets we are interested in.
IN_pWaveformBuffer | EWDB_WaveformStruct | Pointer to a pre-allocated array of waveform structs which will be filled by this function.
IN_pStationBuffer | EWDB_StationStruct | Pointer to a pre-allocated array of station structs which will be filled by this function.
IN_BufferRecLen | int | Length of the IN_pWaveformBuffer array.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_UpdateSnippet()

Prototype: |
int ewdb_internal_UpdateSnippet( | EWDBid IN_idWaveform, char * IN_pSnippet, int IN_iSnippetSize);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_UpdateSnippet.c
Description: | Updates the binary waveform snippet in the database, replacing the old binary snippet with the new one. A snippet and a waveform descriptor must already exist in the DB for the given idWaveform. The idWaveform is the DB ID of the existing waveform descriptor and snippet.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
IN_idWaveform | EWDBid | Database ID of the Waveform associated with this snippet.
IN_pSnippet | char * | Pointer to the binary waveform snippet to be inserted.
IN_iSnippetSize | int | Length of the snippet.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_UpdateWaveformDesc()

Prototype: |
int ewdb_internal_UpdateWaveformDesc( | EWDB_WaveformStruct * pWaveform);
Source File: | src/oracle/schema-working/src/waveform/ewdb_internal_UpdateWaveformDesc.c
Description: | Update an existing waveform descriptor record in the database. The record maintains any existing associations it has. pWaveform should be a pointer to an EWDB_WaveformStruct. pWaveform->idWaveform, pWaveform->tStart, pWaveform->tEnd, pWaveform->binSnippet, and pWaveform->iByteLen must be filled in and valid. idWaveform must be the DB ID of an existing waveform within the DB. pWaveform->idChan is ignored (You are not allowed to change the channel for an existing snippet. If you have erroniously associated a snippet with a channel, you must delete the old snippet, and create a new one to fix the problem. pWaveform->iDataFormat is not currently supported.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
pWaveform | EWDB_WaveformStruct * | Input waveform structure filled by the caller.
Group: | EWDB_API_LIB
Sub Group: | WAVEFORM-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h