PCL Reference Manual > Geometry Functions > Delete Actions
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Delete Actions
This section is used to describe some of the functions used to implement the “Delete” actions.
  
asm_delete_coord
(coord_list, deleted_coords)
 
Description:
This function deletes a set of coordinate frames from the database and the graphics window.
Input:
STRING
coord_list[]
This value specifies the labels of the coordinate frames to be deleted.
Output:
STRING
deleted_coords[]
This value returns the labels of the coordinate frames deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of coordinate frames deleted and their labels.
A coordinate frame is deleted for each coordinate frame label in the list provided that the coordinate frame is not essential for any other entity. The global coordinate frame may not be deleted. Each coordinate frame deleted is removed from the graphics window.
This function can display an information popup message form with the following message:
 
1000143
Unable to delete Global Coordinate Frame.
This function can display a fatal popup message form with the following message:
 
1000025
Error attempting to allocate virtual memory.
Example:
Please see asm_delete_coord (p. 697) in the PCL Reference Manual Examples.
 
asm_delete_curve
(curve_list, deleted_curves)
Description:
This function deletes a set of curves from the database and the graphics window.
Input:
STRING
curve_list[]
This value specifies the labels of the curves to be deleted.
Output:
STRING
deleted_curves[]
This value returns the labels of the curves deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of curves deleted and their labels. It also displays the number of curves not found and their labels.
A curve is deleted for each label in the list provided that the curve is not essential for any other entity. Each curve deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000236
The curve to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_curve (p. 698) in the PCL Reference Manual Examples.
 
asm_delete_grid
(point_list, deleted_points)
Description:
This function deletes a set of points from the database and the graphics window.
Input:
STRING
point_list[]
This value specifies the labels of the points to be deleted.
Output:
STRING
deleted_points[]
This value returns the labels of the points deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of points deleted and their labels. It also displays the number of surfaces not found and their labels.
A point is deleted for each label in the list provided that the point is not essential for any other entity. Each point deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000235
The point to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_grid (p. 699) in the PCL Reference Manual Examples.
asm_delete_hpat
(hypat_list, deleted_hypats)
Description:
This function deletes a set of hyperpatches from the database and the graphics window.
Input:
STRING
hypat_list[]
This value specifies the labels of the hyperpatches to be deleted.
Output:
STRING
deleted_hypats[]
This value returns the labels of the solids deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of hyperpatches deleted and their labels. It also displays the number of hyperpatches not found and their labels.
A hyperpatch is deleted for each label in the list provided that the hyperpatch is not essential for any other entity. Each hyperpatch deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000238
The solid to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_hpat (p. 700) in the PCL Reference Manual Examples.
asm_delete_line
(line_list, deleted_lines)
Description:
This function deletes a set of lines from the database and the graphics window.
Input:
STRING
line_list[]
This value specifies the labels of the lines to be deleted.
Output:
STRING
deleted_lines[]
This value returns the labels of the lines deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of lines deleted and their labels. It also displays the number of lines not found and their labels.
A line is deleted for each label in the list provided that the line is not essential for any other entity. Each line deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000236
The curve to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_line (p. 701) in the PCL Reference Manual Examples.
 
asm_delete_patch
(patch_list, deleted_patches)
Description:
This function deletes a set of patches from the database and the graphics window.
Input:
STRING
patch_list[]
This value specifies the labels of patches to be deleted.
Output:
STRING
deleted_patches[]
This value returns the labels of the patches deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of patches deleted and their labels. It also displays the number of patches not found and their labels.
A patch is deleted for each label in the list provided that the patch is not essential for any other entity. Each patch deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000237
The surface to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_patch (p. 702) in the PCL Reference Manual Examples.
 
asm_delete_plane
(plane_list, deleted_planes)
Description:
This function deletes a set of planes from the database and the graphics window.
Input:
STRING
plane_list[]
This value specifies the labels of the planes to be deleted.
Output:
STRING
deleted_planes[]
This value returns the labels of the planes deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of planes deleted and their labels.
A plane is deleted for each plane label in the list. Each plane deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000243
The plane to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_plane (p. 703) in the PCL Reference Manual Examples.
asm_delete_point
(point_list, deleted_points)
Description:
This function deletes a set of points from the database and the graphics window.
Input:
STRING
point_list[]
This value specifies the labels of the points to be deleted.
Output:
STRING
deleted_points[]
This value returns the labels of the points deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of points deleted and their labels. It also displays the number of surfaces not found and their labels.
A point deleted for each label in the list provided that the point is not essential for any other entity. Each point deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000235
The point to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_point (p. 704) in the PCL Reference Manual Examples.
asm_delete_solid
(solid_list, deleted_solids)
Description:
This function deletes a set of solids from the database and the graphics window.
Input:
STRING
solid_list[]
This value specifies the labels of the solids to be deleted.
Output:
STRING
deleted_solids[]
This value returns the labels of the solids deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of solids deleted and their labels. It also displays the number of solids not found and their labels.
A solid is deleted for each label in the list provided that the solid is not essential for any other entity. Each solid deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000238
The solid to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_solid (p. 705) in the PCL Reference Manual Examples.
asm_delete_surface
(surface_list, deleted_surfaces)
Description:
This function deletes a set of surfaces from the database and the graphics window.
Input:
STRING
surface_list[]
This value specifies the labels of the surfaces to be deleted.
Output:
STRING
deleted_surfaces[]
This value returns the labels of the surfaces deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of surfaces deleted and their labels. It also displays the number of surfaces not found and their labels.
A surface is deleted for each label in the list provided that the surface is not essential for any other entity. Each surface deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000237
The surface to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_surface (p. 706) in the PCL Reference Manual Examples.
 
asm_delete_vector
(vector_list, deleted_vectors)
Description:
This function deletes a set of vectors from the database and the graphics window.
Input:
STRING
vector_list[]
This value specifies the labels of the vectors to be deleted.
Output:
STRING
deleted_vectors[]
This value returns the labels of the vectors deleted.
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:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function displays the number of vectors deleted and their labels.
A vector is deleted for each vector label in the list. Each vector deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
 
38000246
The vector to delete does not exist in the database and may be a geometry construct. Delete operation not allowed on geometry constructs.
Example:
Please see asm_delete_vector (p. 707) in the PCL Reference Manual Examples.