Modified | Function description is incorrect. Modified function and variable descriptions. Also deleted Remarks and Example. |
Original Description Information: | ||
analysis_get.pset_for_job | (analysis_code, anal_stp_name, anal_stp_id ) | |
Description: | ||
Get analysis step ID for analysis step name and analysis code. | ||
Input: | ||
STRING | analysis_code[31] | The name of the analysis code. |
STRING | anal_stp_name[80] | The name of the analysis step. |
Output: | ||
INTEGER | anal_stp_id | The analysis step parameter set ID. |
INTEGER | <Return Value> | Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||
New Description Information: | ||
analysis_get.pset_for_job | (analysis_code, anal_job_name, anal_job_id ) | |
Description: | ||
This function will get the analysis job id for a specific job and analysis code. | ||
Input: | ||
STRING | analysis_code[31] | This value specifies the name of the analysis code. |
STRING | anal_job_name[] | This value specifies the name of the job. |
Output: | ||
INTEGER | anal_job_id | This value returns the identifier associated with the specified analysis code and job name. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Modified | The documentation implies that the user needs to supply the value of the variable NAME for this call, but in reality the value of NAME is supposed to be returned. Changed the variable NAME to be an output argument. |
Original Description Information: | ||
db_get_anal_type_name | (id, name ) | |
Description: | ||
Retrieves the analysis type name associated with the specified analysis type ID. | ||
Input: | ||
INTEGER | id | Integer containing the ID of the analysis type. |
STRING | name[31] | Pointer to a string where the name of the analysis type is to be placed. |
Output: | ||
INTEGER | <Return Value> | Returns the success or failure of the routine. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||
New Description Information: | ||
db_get_anal_type_name | (id, name ) | |
Description: | ||
Retrieves the analysis type name associated with the specified analysis type ID. | ||
Input: | ||
INTEGER | id | Integer containing the ID of the analysis type. |
Output: | ||
STRING | name[31] | Pointer to a string where the name of the analysis type is to be placed. |
INTEGER | <Return Value> | Returns the success or failure of the routine. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||
Modified | The documentation implies that the user needs to supply the value of the variable ID for this call, but in reality the value of ID is supposed to be returned. Changed the variable ID to be an output argument. |
Original Description Information: | ||
db_get_anal_type_id | (name, id, ) | |
Description: | ||
Retrieves the analysis type ID associated with the specified analysis type name. | ||
Input: | ||
STRING | name[31] | Pointer to a string containing the name of the analysis type. |
INTEGER | id | Location to receive the resulting value. |
Output: | ||
INTEGER | <Return Value> | Returns the success or failure of the routine. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||
New Description Information: | ||
db_get_anal_type_id | (name, id, ) | |
Description: | ||
Retrieves the analysis type ID associated with the specified analysis type name. | ||
Input: | ||
STRING | name[31] | Pointer to a string containing the name of the analysis type. |
Output: | ||
INTEGER | id | Location to receive the resulting value. |
INTEGER | <Return Value> | Returns the success or failure of the routine. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||
Modified | The documentation implies that the user need not supply the value of the variable MATRIX for this call, but in reality the value of MATRIX is supposed to be an input argument. Changed the variable MATRIX to be an input argument. |
Original Description Information: | ||
(param_set_id, param_name, matrix ) | ||
Description: | ||
Retrieves the analysis type ID associated with the specified analysis type name. | ||
Input: | ||
INTEGER | param_set_id | Internal unique ID of the matrix values to be retrieved from the database. |
STRING | param_name[80] | Name of the param set being retrieved from the database. |
Output: | ||
REAL | matrix() | The information previously contained in the blob, but returned to the calling routine in a float array. |
INTEGER | <Return Value> | Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||
New Description Information: | ||
(param_set_id, param_name, matrix ) | ||
Description: | ||
Retrieves the analysis type ID associated with the specified analysis type name. | ||
Input: | ||
INTEGER | param_set_id | Internal unique ID of the matrix values to be retrieved from the database. |
STRING | param_name[80] | Name of the param set being retrieved from the database. |
REAL | matrix() | The information previously contained in the blob, but returned to the calling routine in a float array. |
Output: | ||
INTEGER | <Return Value> | Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason. |
Error Conditions: | ||
None. | ||
Remarks: | ||
None. | ||
Examples: | ||
None. | ||