app_db_get_ref_cid | ( domesg, cord_frame ) |
Description: | ||
Get the default reference coordinate frame from the database. | ||
Input: | ||
LOGICAL | domesg | Error message flag: If TRUE, this routine will allow the app_db_err_msg routine to issue a message if an error is encountered. |
Output: | ||
STRING | cord_frame[] | The default reference coordinate frame. |
INTEGER | <Return Value> | Success or an error code. |
asm_u_coord_local_to_global | ( p, t, r, itype, npts ) |
Description: | ||
This function transforms points from local coordinates to global. It passes the transpose of the rotation matrix stored in the database. | ||
Input: | ||
REAL ARRAY | p(3,npts) | The point coordinates in local frame. |
REAL ARRAY | t(3) | This value specifies the translation vector for the global coordinate frame. |
REAL ARRAY | r(3,3) | This value specifies the rotation matrix for the global coordinate frame and is the transpose of the rotation matrix stored in the database. |
INTEGER | itype | The reference coordinate frame type: 1=rectangular 2=cylindrical 3=spherical |
INTEGER | npts | The number of points. |
Output: | ||
REAL ARRAY | p(3,npts) | The point coordinates in global frame. |
Error Conditions: | ||
See the Status Messages (Ch. 11) for information on any error values returned by this function. |
db_check_coord_frame_exist | ( id ) |
Description: | ||
Checks to see if a coordinate frame exists in the database. | ||
Input: | ||
INTEGER | id | The unique internal cid identifying the coordinate frame to be retrieved from the database. |
Output: | ||
LOGICAL | <Return Value> | True if the cid exists. |
Error Conditions: | ||
This routine returns only a logical value, and gives no indication of why a failure occurred. | ||
External Dependencies and Side Effects: | ||
Accesses one record in the “coordinate_frame” table in the database. |
db_count_coordinate_frame | ( count ) |
Description: | ||
Counts all coordinate_frames in the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | count | The integer number of coordinate_frames in the database. |
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 | |
External Dependencies and Side Effects: | ||
Queries “coordinate_frame” table in the database. |
db_get_all_coord_frame_ids | ( ) |
Description: | ||
This function will set a cursor to the start of a list of all coordinate frames. | ||
Input: | ||
none | ||
Output: | ||
none |
db_get_next_coord_frame_ids | ( id ) |
Description: | ||
This function will get the next coordinate frame id from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | id | This value returns the id of the next coordinate frame id. |
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. |
Remarks: | ||
The PCL function db_get_all_coord_frame_ids() must be called at least once to establish the list of posted coordinate frame id values and to set the cursor to point to the start of the list. Calling the db_get_next_coord_frame_ids() function in a loop will then allow the list entries to be retrieved. | ||
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 “coordinate frame” table in the database. |
db_get_max_coord_label | ( label ) |
Description: | ||
Gets the largest coord label from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | label | Highest coord label used. |
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: | ||
13000056 | Coordinate frame not found. | |
13000007 | An unspecified database error occurred. | |
External Dependencies and Side Effects: | ||
Selects the largest coord label from the database. |
db_get_min_coord_label | ( label ) |
Description: | ||
Gets the smallest coord label from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | label | Lowest coord label used. |
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: | ||
13000056 | Coordinate frame not found. | |
13000007 | An unspecified database error occurred. | |
External Dependencies and Side Effects: | ||
Selects the smallest coord label from the database. |
db_get_all_posted_coord | ( ) |
Description: | ||
This function will set a cursor to the start of a list of posted coordinate frames. | ||
Input: | ||
none | ||
Output: | ||
none |
db_get_next_posted_coord | ( id ) |
Description: | ||
This function will get the next posted coordinate frame id from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | id | This value returns the id of the next posted coordinate frame id. |
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. |
Remarks: | ||
The PCL function db_get_all_posted_coord() must be called at least once to establish the list of posted coordinate frame id values and to set the cursor to point to the start of the list. Calling the db_get_next_posted_coord() function in a loop will then allow the list entries to be retrieved. | ||
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 “coordinate frame” table in the database. |
asm_db_get_next_cord_label | ( domessage, integerlabel, stringlabel ) |
Description: | ||
Get the next highest coord label from the database. | ||
Input: | ||
LOGICAL | domessage | Tells the routine to issue an error message if an error occurs. |
Output: | ||
INTEGER | integerlabel | The next highest coord label. |
STRING | stringlabel[] | The next highest coord label. |
INTEGER | <Return Value> | Success or an error code. |
db_get_coord_frame_label | ( id, label ) |
Description: | ||
Gets a label from the database given an id. | ||
Input: | ||
INTEGER | id | The unique internal id identifying the coord to be retrieved from the database. |
Output: | ||
INTEGER | label | The unique external id identifying the coord to be retrieved from the database. |
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. | |
External Dependencies and Side Effects: | ||
Accesses one record in the “coordinate_frame” table in the database. |
db_get_current_coord | ( coord_label ) |
Description: | ||
Retrieves the current coordinate frame from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | label | Location for returned value. |
INTEGER | <Return Value> | Returns the success or failure of the routine. |
Error Conditions: | ||
13000002 | Unrecoverable database error. | |
13000056 | Coordinate frame not found | |
13000007 | An unspecified database error occurred. |