ewdb_internal_GetAmpsByEvent()

Prototype: |
int ewdb_internal_GetAmpsByEvent( | EWDBid idEvent, AMPLITUDE_TYPE iAmpType, EWDB_PeakAmpStruct * pAmpBuffer, int * pNumAmpsFound, int * pNumAmpsRetrieved, int iBufferLen);
Source File: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h
Description: | Function retrieves a list of amplitudes of a given type that are associated with a given DB Event. Use idEvent to define the DB Event for which you want a list of associated amplitudes.
Note: | This function only retrieves amplitudes that are directly associated with an Event. It will not retrieve amplitudes that have been associated with an Event via a Magnitude.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_WARNING | Partial success. A list of amplitudes was retrieved, but the caller's buffer was not large enough to accomadate all of the amplitudes found. See pNumAmpsFound for the number of arrivals found and pNumAmpsRetrieved for the number of amplitudes placed in the caller's buffer.
PARAMETER INFO
Parameter | Type | Description
idEvent | EWDBid | DB identifier of the Event for which the caller wants a list of associated amplitudes.
iAmpType | AMPLITUDE_TYPE | Type of amplitude the caller is searching for. "Amplitude Type" constants are defined in .
pAmpBuffer | EWDB_PeakAmpStruct * | Buffer allocated by the caller, where the function will write the list of amplitudes retrieved.
pNumAmpsFound | int * | Pointer to an integer where the function will write the number of amplitudes found.
pNumAmpsRetrieved | int * | Pointer to an integer where the function will write the number of amplitudes retrieved and placed in the caller's buffer(pAmpBuffer).
iBufferLen | int | Size of the pAmpBuffer buffer in as a multiple of EWDB_PeakAmpStruct. (example: 15 structs)
Group: | EWDB_ORA_API
Sub Group: | PARAMETRIC-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetAmpsByEvent_w_StaInfo()

Prototype: |
int ewdb_internal_GetAmpsByEvent_w_StaInfo( | EWDBid idEvent, AMPLITUDE_TYPE iAmpType, EWDB_PeakAmpStruct * pAmpBuffer, EWDB_StationStruct * pStationBuffer, int * pNumAmpsFound, int * pNumAmpsRetrieved, int iBufferLen);
Source File: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h
Description: | Function retrieves a list of amplitudes of a given type, along with associated station/channel info, that are associated with a given DB Event. Use idEvent to define the DB Event for which you want a list of associated amplitudes.
Note: | This function only retrieves amplitudes that are directly associated with an Event. It will not retrieve amplitudes that have been associated with an Event via a Magnitude.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_WARNING | Partial success. A list of amplitudes was retrieved, along with associated channel/station information, but the caller's buffer was not large enough to accomadate all of the amplitudes found. See pNumAmpsFound for the number of arrivals found and pNumAmpsRetrieved for the number of amplitudes placed in the caller's buffer.
PARAMETER INFO
Parameter | Type | Description
idEvent | EWDBid | DB identifier of the Event for which the caller wants a list of associated amplitudes.
iAmpType | AMPLITUDE_TYPE | Type of amplitude the caller is searching for. "Amplitude Type" constants are defined in .
pAmpBuffer | EWDB_PeakAmpStruct * | Buffer allocated by the caller, where the function will write the list of amplitudes retrieved.
pStationBuffer | EWDB_StationStruct * | Buffer allocated by the caller, where the function will write the list of station/channel info associated with the amplitudes retrieved.
pNumAmpsFound | int * | Pointer to an integer where the function will write the number of amplitudes found.
pNumAmpsRetrieved | int * | Pointer to an integer where the function will write the number of amplitudes retrieved and placed in the caller's buffer(pAmpBuffer).
iBufferLen | int | Size of the pAmpBuffer buffer in as a multiple of EWDB_PeakAmpStruct. (example: 15 structs) pStationBuffer must also contain space for this many EWDB_StationStruct records.
Group: | EWDB_ORA_API
Sub Group: | PARAMETRIC-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetAmpsByTime()

Prototype: |
int ewdb_internal_GetAmpsByTime( | time_t tStart, time_t tEnd, AMPLITUDE_TYPE iAmpType, EWDB_PeakAmpStruct * pAmpBuffer, int * pNumAmpsFound, int * pNumAmpsRetrieved, int iBufferLen);
Source File: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h
Description: | Function retrieves a list of amplitudes of a given type for a given time window. Use tStart and tEnd to specify the time window for which you are interested in amplitudes.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_WARNING | Partial success. A list of amplitudes was retrieved, but the caller's buffer was not large enough to accomadate all of the amplitudes found. See pNumAmpsFound for the number of arrivals found and pNumAmpsRetrieved for the number of amplitudes placed in the caller's buffer.
PARAMETER INFO
Parameter | Type | Description
tStart | time_t | Start time of criteria window. (Secs since 1970)
tEnd | time_t | End time of criteria window. (Secs since 1970)
iAmpType | AMPLITUDE_TYPE | Type of amplitude the caller is searching for. "Amplitude Type" constants are defined in .
pAmpBuffer | EWDB_PeakAmpStruct * | Buffer allocated by the caller, where the function will write the list of amplitudes retrieved.
pNumAmpsFound | int * | Pointer to an integer where the function will write the number of amplitudes found.
pNumAmpsRetrieved | int * | Pointer to an integer where the function will write the number of amplitudes retrieved and placed in the caller's buffer(pAmpBuffer).
iBufferLen | int | Size of the pAmpBuffer buffer in as a multiple of EWDB_PeakAmpStruct. (example: 15 structs) If pStationBuffer is not NULL, then it must also contain space for this many EWDB_StationStruct records.
Group: | EWDB_ORA_API
Sub Group: | PARAMETRIC-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetAmpsByTime_w_StaInfo()

Prototype: |
int ewdb_internal_GetAmpsByTime_w_StaInfo( | time_t tStart, time_t tEnd, AMPLITUDE_TYPE iAmpType, EWDB_PeakAmpStruct * pAmpBuffer, EWDB_StationStruct * pStationBuffer, int * pNumAmpsFound, int * pNumAmpsRetrieved, int iBufferLen);
Source File: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h
Description: | Function retrieves a list of amplitudes of a given type, plus associated station/channel info for a given time window. Use tStart and tEnd to specify the time window for which you are interested in amplitudes.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_WARNING | Partial success. A list of amplitudes (plus associated channel/station info) was retrieved, but the caller's buffer was not large enough to accomadate all of the amplitudes found. See pNumAmpsFound for the number of arrivals found and pNumAmpsRetrieved for the number of amplitudes placed in the caller's buffer.
PARAMETER INFO
Parameter | Type | Description
tStart | time_t | Start time of criteria window. (Secs since 1970)
tEnd | time_t | End time of criteria window. (Secs since 1970)
iAmpType | AMPLITUDE_TYPE | Type of amplitude the caller is searching for. "Amplitude Type" constants are defined in .
pAmpBuffer | EWDB_PeakAmpStruct * | Buffer allocated by the caller, where the function will write the list of amplitudes retrieved.
pStationBuffer | EWDB_StationStruct * | Buffer allocated by the caller, where the function will write the list of station/channel info associated with the amplitudes retrieved. pStationBuffer must point to an allocated buffer with room for atleast (iBufferLen) EWDB_StationStructs.
pNumAmpsFound | int * | Pointer to an integer where the function will write the number of amplitudes found.
pNumAmpsRetrieved | int * | Pointer to an integer where the function will write the number of amplitudes retrieved and placed in the caller's buffer(pAmpBuffer).
iBufferLen | int | Size of the pAmpBuffer buffer in as a multiple of EWDB_PeakAmpStruct. (example: 15 structs) pStationBuffer must also contain space for this many EWDB_StationStruct records.
Group: | EWDB_ORA_API
Sub Group: | PARAMETRIC-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h