Tutorial Toolkit Function Descriptions > Obsolete, Modified, and Broken Functions > Geometry (Chapter 7)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Geometry (Chapter 7)
Modified
When running this call, MSC.Patran outputs the error message “Invalid datatype to built-in function. Arg#1”.
Changed the variable DOMESSAGE from type integer to type logical.
Original Description Information:
(domessage, integerlabel, stringlabel )
Description:
Get the next highest grid label from the database.
Input:
INTEGER
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
status
Success or an error code.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(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.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
When running this call, MSC.Patran outputs the error message “Invalid datatype to built-in function. Arg#1”.
Changed the variable DOMESSAGE from type integer to type logical.
Original Description Information:
(domessage, integerlabel, stringlabel )
Description:
Get the next highest line label from the database.
Input:
INTEGER
domessage
Tells the routine to issue an error message if an error occurs.
Output:
INTEGER
integerlabel
The next highest curve label.
STRING
stringlabel[]
The next highest curve label.
INTEGER
status
Success or an error code.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(domessage, integerlabel, stringlabel )
Description:
Get the next highest line 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 curve label.
STRING
stringlabel[]
The next highest curve label.
INTEGER
<Return Value>
Success or an error code.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
  
 
 
Modified
When running this call MSC.Patran outputs the error message “Invalid datatype to built-in function. Arg#1”. When this issue is corrected MSC.Patran outputs the error message “Wrong number of arguments for built-in function”. In addition to these two issues this call is missing its <Return Value> variable.
Changed the variable DOMESSAGE from type integer to type logical. Removed the variable STATUS from the routine since it only has 3 arguments and not 4. Also added the <Return Value> variable to the list of output arguments.
Original Description Information:
asm_db_get_next_patch_label
(domessage, integerlabel, stringlabel, status )
Description:
Get the next highest patch label from the database.
Input:
INTEGER
domessage
Tells the routine to issue an error message if an error occurs.
Output:
INTEGER
integerlabel
The next highest curve label.
STRING
stringlabel[]
The next highest curve label.
INTEGER
status
Success or an error code.
Error Conditions:
None.
Remarks:
None.
Example:
None.
New Description Information:
asm_db_get_next_patch_label
(domessage, integerlabel, stringlabel )
Description:
Get the next highest patch 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 surface label.
STRING
stringlabel[]
The next highest surface label.
INTEGER
<Return Value>
Success or an error code.
Error Conditions:
None.
Remarks:
None.
Example:
None.
 
Modified
This PCL function is listed as having four arguments when it really has seven arguments.
Added the three input arguments to the document description for this call
 
Original Description Information:
(surflist, scaled, numsurf, segid )
Description:
Routine that calculates and shows the surface normals.
Input:
STRING
surflist[]
The list of surfaces.
LOGICAL
scaled
TRUE if user wants to scale the normals to a percentage of the surface area, FALSE otherwise.
INTEGER
numsurf
The number of surfaces (or segments).
INTEGER
segid
The ID of the segment.
Output:
INTEGER
<Return Value>
0 if successful, else returns error code.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(surflist, scaled, numsurf, segid, regflag, vecdens, veclen )
Description:
Routine that calculates and shows the surface normals.
Input:
STRING
surflist[]
The list of surfaces.
LOGICAL
scaled
TRUE if user wants to scale the normals to a percentage of the surface area, FALSE otherwise.
INTEGER
numsurf
The number of surfaces (or segments).
INTEGER
segid
The ID of the segment.
INTEGER
regflag
0 to show vectors on interior and boundary and 1 to show vectors on boundary only.
INTEGER
vecdens
The number of vectors in the u, v directions.
REAL
veclen
The length of the vectors if non scaled.
Output:
INTEGER
<Return Value>
0 if successful, else returns error code.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
When running this call MSC.Patran outputs the error message “Invalid datatype to built-in function. Arg#1”.
Changed the variable DOMESSAGE from type integer to type logical.
Original Description Information:
(domessage, integerlabel, stringlabel )
Description:
Get the next unused hpat label from the database.
Input:
INTEGER
domessage
Tells the routine to issue an error message if an error occurs.
Output:
INTEGER
integerlabel
The next highest solid label.
STRING
stringlabel[]
The next highest solid label.
INTEGER
<Return Value>
Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(domessage, integerlabel, stringlabel )
Description:
Get the next unused hpat 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 solid label.
STRING
stringlabel[]
The next highest solid label.
INTEGER
<Return Value>
Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
Modified
The documentation implies that the user needs to supply the value of the variable BLOB for this call since it is an input/output argument, but in reality the value of BLOB is only supposed to be returned value.
Changed the variable BLOB to be only an output argument.
 
Original Description Information:
(solidid, blobsize, blob, status )
Description:
Get the geometric definition of a solid from the database.
Input:
INTEGER
solidid
ID of the solid.
INTEGER
blobsize
The size of the blob in words.
REAL
blob()
Array to be filled in with Geometric description of a solid as a blob.
Output:
REAL
blob()
 
INTEGER
status
0: no error.
-1: database error.
-2: insufficient array length for the blob.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(solidid, blobsize, blob, status )
Description:
Get the geometric definition of a solid from the database.
Input:
INTEGER
solidid
ID of the solid.
INTEGER
blobsize
The size of the blob in words.
Output:
REAL
blob()
Array to be filled in with Geometric description of a solid as a blob.
INTEGER
status
0: no error.
-1: database error.
-2: insufficient array length for the blob.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
The routine was missing its argument list.
Added the two input arguments and the <Return Value> argument to the document description for this call.
Original Description Information:
( )
Description:
Maintain the widgets for the SGM -> VERIFY -> SOLID BREP command.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(surface_list, verify_tol )
Description:
Maintain the widgets for the SGM -> VERIFY -> SOLID BREP command.
Input:
STRING
surface_list[]
The list of surfaces to use.
REAL
verify_tol
The verify tolerance to use.
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
This call is missing its <Return Value> variable.
Add the <Return Value> variable to the list of output arguments.
Original Description Information:
(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.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
New Description Information:
(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>
Integer indicating success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
 
 
 
 
 
 
 
 
 
 
Modified
When running this call, MSC.Patran outputs the error message “Invalid datatype to built-in function. Arg#1”. In addition to this issue, the call is missing its <Return Value> variable.
Changed the variable DOMESSAGE from type integer to type logical. Also added the <Return Value> variable to the list of output arguments.
Original Description Information:
(domessage, integerlabel, stringlabel )
Description:
Get the next highest coord label from the database.
Input:
INTEGER
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
status
Success or an error code.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
New Description Information:
(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.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Broken
This function can incorrectly return a value of 13000007, “An unspecified database error occurred”.
No resolution has been found for this issue.
Original Description Information:
( )
Description:
This function will set a cursor to the start of a list of all coordinate frames.
Input:
none
Output:
none
Remarks:
This function must be called before the db_get_next_coord_frame_ids() function can be called.
Example:
INTEGER  status
INTEGER  id
 
db_get_all_coord_frame_ids ( )
 
WHILE ( status == 0 )
    status = db_get_next_coord_frame_ids ( id )
END WHILE
 
 
Modified
The documentation implies that the user needs to supply the value of the variable COORD_LABEL for this call, but in reality the value of COORD_LABEL is supposed to be returned.
Changed the variable COORD_LABEL to be an output argument.
 
Original Description Information:
(coord_label )
Description:
Retrieves the current coordinate frame from the database.
Input:
INTEGER
coord_label
Location for returned value.
Output:
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(coord_label )
Description:
Retrieves the current coordinate frame from the database.
Input:
None.
Output:
INTEGER
coord_label
Location for returned value.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Modified
When a <Return Value> is used with this call, MSC.Patran outputs the error message “Invalid assignment conversion, Extra information”.
Removed the <Return Value> variable from the documented description.
Original Description Information:
(edgid, count, srfid )
Description:
Finds the ids of all surfaces associated with a specified edge in the database.
Input:
INTEGER
edgid
ID of the edge to which the surfaces are associated.
INTEGER
count
The number of surfaces that the calling routine expects to receive from the database. This count should be the same as the number of surfaces to which the edge is associated as it should have been fetched from the database prior to making this call.
Output:
INTEGER
srfid()
IDs of the various surfaces associated with the specified edge.
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.
Example:
None.
 
New Description Information:
(edgid, count, srfid )
Description:
Finds the ids of all surfaces associated with a specified edge in the database.
Input:
INTEGER
edgid
ID of the edge to which the surfaces are associated.
INTEGER
count
The number of surfaces that the calling routine expects to receive from the database. This count should be the same as the number of surfaces to which the edge is associated as it should have been fetched from the database prior to making this call.
Output:
INTEGER
srfid()
IDs of the various surfaces associated with the specified edge.
Error Conditions:
None.
Remarks:
None.
Example:
None.
 
Modified
When a <Return Value> is used with this call, MSC.Patran outputs the error message “Invalid assignment conversion, Extra information”.
Removed the <Return Value> variable from the documented description.
Original Description Information:
(srfid, count, solid )
Description:
Finds the ids of all solids associated with a specified surface in the database.
Input:
INTEGER
srfid
ID of the surface to which the solids are associated.
INTEGER
count
The number of solids that the calling routine expects to receive from the database. This count should be the same as the number of solids to which the surface is associated as it should have been fetched from the database prior to making this call.
Output:
INTEGER
solid()
IDs of the various solids associated with the specified surface.
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.
Example:
None.
New Description Information:
(srfid, count, solid )
Description:
Finds the ids of all solids associated with a specified surface in the database.
Input:
INTEGER
srfid
ID of the surface to which the solids are associated.
INTEGER
count
The number of solids that the calling routine expects to receive from the database. This count should be the same as the number of solids to which the surface is associated as it should have been fetched from the database prior to making this call.
Output:
INTEGER
solid()
IDs of the various solids associated with the specified surface.
Error Conditions:
None.
Remarks:
None.
Example:
None.