| Prototype: |
| int ewdb_api_GetAmpsByEvent( |
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/ewdb_ora_api.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. If you want station information for the channel associated with each amplitude, allocate space for pStationBuffer, otherwise set pStationBuffer to NULL, and station information will not be retrieved. |
| 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. |
| pStationBuffer |
EWDB_StationStruct * |
Buffer allocated by the caller, where the function will write the list of station/channel info associated with the amplitudes retrieved. If pStationBuffer is set to NULL by the caller, then the function will not attempt to retrieve Station information for the retrieved amplitudes. If pStationBuffer is NOT NULL, then the function will fill out an EWDB_StationStruct for the channel associated with each amplitude. |
| 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_API |
| Language: |
C |
| Location: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |
| Prototype: |
| int ewdb_api_GetAmpsByOrigin( |
EWDBid idOrigin, AMPLITUDE_TYPE iAmpType, EWDB_PeakAmpStruct * pAmpBuffer, EWDB_StationStruct * pStationBuffer, int * pNumAmpsFound, int * pNumAmpsRetrieved, int iBufferLen); |
|
| Source File: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |
| Description: |
Function retrieves a list of amplitudes of a given type that are associated with a given DB Origin. Use idOrigin to define the DB Origin for which you want a list of associated amplitudes. If you want station information for the channel associated with each amplitude, allocate space for pStationBuffer, otherwise set pStationBuffer to NULL, and station information will not be retrieved. |
| Note: |
This function only retrieves amplitudes that are directly associated with an Origin, or the Event with which that Origin is associated. It will not retrieve amplitudes that have been associated with an Origin 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 |
| idOrigin |
EWDBid |
DB identifier of the Origin 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. If pStationBuffer is set to NULL by the caller, then the function will not attempt to retrieve Station information for the retrieved amplitudes. If pStationBuffer is NOT NULL, then the function will fill out an EWDB_StationStruct for the channel associated with each amplitude. |
| 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_API |
| Language: |
C |
| Location: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |
| Prototype: |
| int ewdb_api_GetAmpsByTime( |
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/ewdb_ora_api.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. If you want station information for the channel associated with each amplitude, allocate space for pStationBuffer, otherwise set pStationBuffer to NULL, and station information will not be retrieved. |
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. |
| pStationBuffer |
EWDB_StationStruct * |
Buffer allocated by the caller, where the function will write the list of station/channel info associated with the amplitudes retrieved. If pStationBuffer is set to NULL by the caller, then the function will not attempt to retrieve Station information for the retrieved amplitudes. If pStationBuffer is NOT NULL, then the function will fill out an EWDB_StationStruct for the channel associated with each amplitude. |
| 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_API |
| Language: |
C |
| Location: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |
| Prototype: |
| int ewdb_api_GetEventForOrigin( |
EWDBid idOrigin, EWDBid * idEvent); |
|
| Source File: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |
| Description: |
Function returns the DB ID of the Event associated with the given Origin. If "zero" or "more than one" Events are associated with the given origin, then an error is returned. |
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 |
| idOrigin |
EWDBid |
The DB identifier of the Origin for which the caller wants to obtain the DB Event. |
| idEvent |
EWDBid * |
Pointer to an EWDBid value, where the function will write the DB ID of the Event associated with the given Origin. |
|
|
| Group: |
EWDB_ORA_API |
| Sub Group: |
PARAMETRIC_API |
| Language: |
C |
| Location: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |