db_activate_load_case | (name) |
Description: | ||
Activates the specified load case in the model. | ||
Input: | ||
STRING | name[80] | Name of the load case to be activated. |
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: | ||
13000002 | Unrecoverable database error. | |
13000052 | Load Case Not Found. | |
13000007 | An unspecified database error occurred. | |
External Dependencies and Side Effects: | ||
Updates one record in the “load case” table in the database. |
db_delete_load_case |
Description: | ||
Deletes a load case entry from the database | ||
Input: | ||
STRING | name[80] | Name of the load case to be deleted. |
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: | ||
13000002 | Unrecoverable database error. | |
13000052 | Load Case Not Found. | |
13000076 | Load case active | |
13000007 | An unspecified database error occurred. | |
External Dependencies and Side Effects: | ||
Deletes one record in the “load case” table in the database. |
db_find_load_case_id | ( jbname, lc_seqno, lc_id ) |
Description: | ||
Gets all load case ids from the database in one structure. | ||
Input: | ||
STRING | jbname[] | The jobname used for the desired run. |
INTEGER | lc_seqno | The load case sequence number for the desired load case. |
Output: | ||
INTEGER | lc_id | The id of the desired load case. |
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: | ||
13000002 | Unrecoverable database error. | |
13000007 | An unspecified database error occurred. | |
13000052 | Load Case Not Found. | |
External Dependencies and Side Effects: | ||
Accesses the “load_case” table in the database and retrieves an id of a specified jobname/load case sequence number. |
db_count_load_cases | ( load_case_count ) |
Description: | ||
This function returns the number of load cases defined in the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | load_case_count | This value returns the number of load cases defined in the database. |
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. |
db_get_all_load_case_names | ( ) |
Description: | ||
Gets all load cases from the database. | ||
Input: | ||
None | ||
Output: | ||
INTEGER | <Return Value> | Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason |
db_get_all_load_cases | ( ) |
Description: | ||
This function will set a cursor to the start of a list of load cases. | ||
Input: | ||
None | ||
Output: | ||
None |
db_get_next_load_case | ( name, id, type, description, num_lbc, lbc, dyn_load, map, priority ) |
Description: | ||
This function will get the next load case from the database. | ||
Input: | ||
None | ||
Output: | ||
STRING | name[80] | This value returns the name of the load case retrieved. |
INTEGER | id | This value returns the load case id. |
INTEGER | type | This value returns the load case type. |
STRING | description[256] | This value returns the description of the load case. |
INTEGER | num_lbc | This value returns the number of load and boundary conditions associated with the load case. |
INTEGER | lbc[num_lbc] | This value returns the ids of the loads and boundary conditions associated with this load case. |
INTEGER | dyn_load | This value returns the name of the dynamic load case used as a basis for this load case. This value is valid only if the load case is a static load case created from a dynamic load case. |
REAL | map | This value returns a map variable. |
INTEGER | priority | This value returns the priority assigned to the load case. |
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. |
Error Conditions: | ||
13000002 | Unrecoverable database error. | |
13000007 | An unspecified database error occurred. | |
13000085 | Cursor not open. | |
13000117 | The query specified has completed. | |
External Dependencies and Side Effects: | ||
Accesses all records in the “load case” table in the database. |
db_get_lc_id_given_job_seq | ( ac_id, jobname, lcseq, lcid ) |
Description: | ||
Gets all load case ids from the database in one structure. | ||
Input: | ||
INTEGER | ac_id | Analysis code id for the requested jobname. |
STRING | jobname[] | The jobname used for the desired run. |
INTEGER | lcseq | The load case sequence number for the desired load case. |
Output: | ||
INTEGER | lcid | The id of the desired load case. |
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: | ||
13000002 | Unrecoverable database error. | |
13000007 | An unspecified database error occurred. | |
13000052 | Load Case Not Found | |
External Dependencies and Side Effects: | ||
Accesses the “load_case” table in the database and retrieves an id of a specified jobname/load case sequence number. |