asm_db_create_grid | (location, grid_label, yes_to_all, no_to_all, yes_to_all_dup, no_to_all_dup, status) |
Description: | ||
This function creates a grid in the database and the graphical user-interface. | ||
Input: | ||
REAL ARRAY | location(3) | The xyz location of the point. |
INTEGER | grid_label | Label of next grid to create. =0 Database will use the next highest label for the next grid to create. If grid found within tolerance, returns currently existing grid label, otherwise returns new label. >0 User-definable. |
LOGICAL | yes_to_all | = TRUE if grid already exists in database with same label and user wants to overwrite old grid with new grid. |
LOGICAL | no_to_all | = TRUE if grid already exists in database with same label and user does not want to overwrite old grid with new grid. |
LOGICAL | yes_to_all_dup | = TRUE if grid already exists in database within tolerance and same label and user wants to create duplicate grids. |
LOGICAL | no_to_all_dup | = TRUE if grid already exists in database within tolerance and same label and user does not want to create duplicate grids. |
Output: | ||
INTEGER | status | The value of 0 is returned when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages (Ch. 11) for information on any error values returned by this function. |
db_count_point | ( count ) |
Description: | ||
Counts all points in the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | count | The integer number of points 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. |
db_get_max_point_label | ( label ) |
Description: | ||
Gets the largest point label from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | label | Highest point 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. |
db_get_min_point_label | ( label ) |
Description: | ||
Gets the smallest point label from the database. | ||
Input: | ||
none | ||
Output: | ||
INTEGER | label | Lowest point 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. |
db_get_point_association_count | ( point_id, assoc_count ) |
Description: | ||
Returns the number of higher order entities associated with this point. | ||
Input: | ||
INTEGER | point_id | The point id. |
Output: | ||
INTEGER | assoc_count | The number of higher order entities associated with this point. |
INTEGER | <Return Value> | Returns the success or failure of the routine. |
db_get_point_id | ( label, id ) |
Description: | ||
Gets a point id from the database given a point label. | ||
Input: | ||
INTEGER | label | The unique external point ID identifying the point to be retrieved from the database. |
Output: | ||
INTEGER | id | The unique internal point id identifying the point 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. |
db_get_point_label | ( id, label ) |
Description: | ||
Gets a point label from the database given a point id. | ||
Input: | ||
INTEGER | id | The unique internal point id identifying the point to be retrieved from the database. |
Output: | ||
INTEGER | label | The unique external point id identifying the point 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. |
db_get_point_coo_and_type | ( id, coo, type ) |
Description: | ||
Gets a geometric coo and type from the database given an id. | ||
Input: | ||
INTEGER | id | The association of the information to be retrieved from the database. |
Output: | ||
INTEGER | coo | The geometric company of origin stored in the database. |
INTEGER | type | The geometric type of data stored 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. |
asm_db_get_next_grid_label | ( domessage, integerlabel, stringlabel ) |
Description: | ||
Get the next highest grid 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 grid label. |
STRING | stringlabel[] | The next highest grid label. |
INTEGER | <Return Value> | Success or an error code. |
sgm_db_get_point | ( pointid, xyz, status ) |
Description: | ||
Get the geometric definition of a point from the database. | ||
Input: | ||
INTEGER | pointid | Id of the point. |
Output: | ||
REAL | xyz (3) | Global coordinates of a point. |
INTEGER | status | Success or an error code. |
sgm_edit_point_equivalence | (point_ids, created_ids) |
Description: | ||
This function checks the equivalence of two points and deletes one of the duplicate points. | ||
Input: | ||
STRING | point_ids[ ] | The points whose equivalence is to be checked. |
Output: | ||
STRING | created_ids[ ] | This value returns the created ID list. |
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: | ||
See the Status Messages (Ch. 11) for information on any error values returned by this function. |
sgm_get_close_points | (point_location, tolerance, num_only, vertices_only, sort_option, num_point, point_ids, distances ) |
Description: | ||
This function gets the points around a point within a specified distance. | ||
Input: | ||
REAL ARRAY | point_location(3) | The xyz location of the point in space. |
REAL | tolerance | The distance within which to search for points. |
INTEGER | num_only | 1 to get the num of points only, 0 to get the point ids and the distances. |
INTEGER | vertices_only | 0 to get all points, 1 to get vertices only. |
INTEGER | sort_option | 1 to sort the point ids and distances. |
Output: | ||
INTEGER | num_point | The number of points within the tolerance around the location. |
INTEGER ARRAY | point_ids(num_points) | Point ids of the points. |
REAL ARRAY | distances(num_points) | Distances of the points from the location specified. |
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: | ||
See the Status Messages (Ch. 11) for information on any error values returned by this function. |
sgm_node_on_point | ( geotol, num_pts, pt_id_list, num_nodes, node_id_list ) |
Description: | ||
Get the nodes close to the given points within the geometric tolerance. | ||
Input: | ||
REAL | geotol | The geometric tolerance. |
INTEGER | num_pts | The number of the given points. |
INTEGER | pt_id_list (num_pts) | The ID list of the given points. |
Output: | ||
INTEGER | num_nodes ( ) | The number of the nodes found. |
INTEGER | node_id_list (num_nodes) | The ID list of the nodes found. |
INTEGER | <Return Value> | Success or an error code. |
Error Conditions: | ||
1000025 | Error attempting to allocate virtual memory. | |
1000305 | Coordinates for point %I% not found. | |
1000303 | No points were found to exist in the database as defined in the point list. The point list input was %A%. | |
48000004 | No Node found ! |