Tutorial Toolkit Function Descriptions > Obsolete, Modified, and Broken Functions > Group (Chapter 6)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Group (Chapter 6)
 
Modified
The documentation implies that the user needs to supply the value of the variable COUNT for this call, but in reality the value of COUNT is supposed to be returned.
Changed the variable COUNT to be an output argument.
Original Description Information:
( name, type, count )
Description:
Counts all entities in the specified group name.
Input:
STRING
name[]
Pointer to a string containing the name of the group.
INTEGER
type
The type of entity to be counted.
INTEGER
count
Location to receive the resulting entity count.
Output:
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
( name, type, count )
Description:
Counts all entities in the specified group name.
Input:
STRING
name[]
Pointer to a string containing the name of the group.
INTEGER
type
The type of entity to be counted.
Output:
INTEGER
count
Location to receive the resulting entity count.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Examples:
None.
New
None.
 
None.
 
 
Modified
Missing the db_get_orphan_mpcs call in the original MSC.Acumen documentation.
Added this call to the documentation.
 
New Descriptio6n Information:
( count, entity_id )
Description:
 
 
Gets the entities not in a group.
Input:
 
 
INTEGER
count
The number of entities not in a group.
Output:
 
 
INTEGER
entity_id()
Array of orphan entity ids.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
 
None.
Remarks:
 
None.
Examples:
 
None.
 
 
Modified
The documentation implies that the user needs to supply the value of the variable COUNT for this call, but in reality the value of COUNT is supposed to be returned.
Changed the variable COUNT to be an output argument.
Original Description Information:
( count )
Description:
This function will count all of the elements that do not belong to any group. It will build a list of these elements in the process and this list will be saved for a subsequent call to “DbGetOrphanElems”.
Input:
INTEGER
count
The address of where to store the resultant count value.
Output:
INTEGER
count
The number of elements not associated with any group.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
( count )
Description:
This function will count all of the elements that do not belong to any group. It will build a list of these elements in the process and this list will be saved for a subsequent call to “DbGetOrphanElems”.
Input:
None.
Output:
INTEGER
count
The number of elements not associated with any group.
INTEGER
<Return Value>
Returns the 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#3”.
Changed the variable VISIBLE from type integer to type logical.
Original Description Information:
( mpc_id, gid, visible )
Description:
Add an mpc to a group.
Input:
INTEGER
mpc_id
The mpc_id.
INTEGER
gid
The group ID.
INTEGER
visible
TRUE(1) if the mpcs are to be considered visible.
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:
None.
Remarks:
None.
Examples:
None.
New Description Information:
( mpc_id, gid, visible )
Description:
Add an mpc to a group.
Input:
INTEGER
mpc_id
The mpc_id.
INTEGER
gid
The group ID.
LOGICAL
visible
TRUE if the mpcs are to be considered visible.
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:
None.
Remarks:
None.
Examples:
None.
Modified
Missing the db_get_orphan_curves call in the original MSC.Acumen documentation.
Added this call to the documentation.
 
New Description Information:
( count, entity_id )
Description:
Returns the curve entities not in a group.
Input:
INTEGER
count
Max number of entities returned.
Output:
INTEGER
entity_id()
Array of orphan entity ids.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
Modified
Missing the db_get_orphan_points call in the original MSC.Acumen documentation.
Added this call to the documentation.
 
New Description Information:
( count, entity_id )
Description:
Returns the point entities not in a group.
Input:
INTEGER
count
Max number of entities returned.
Output:
INTEGER
entity_id()
Array of orphan entity ids.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
Missing the db_get_orphan_solids call in the original MSC.Acumen documentation.
Added this call to the documentation.
New Description Information:
( count, entity_id )
Description:
Returns the solid entities not in a group.
Input:
INTEGER
count
Max number of entities returned.
Output:
INTEGER
entity_id()
Array of orphan entity ids.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
Missing the db_get_orphan_surfaces call in the original MSC.Acumen documentation.
Added this call to the documentation.
New Description Information:
( count, entity_id )
Description:
Returns the solid entities not in a group.
Input:
INTEGER
count
Max number of entities returned.
Output:
INTEGER
entity_id()
Array of orphan entity ids.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Example:
None.
 
Modified
When running this call, MSC.Patran outputs the error message “Invalid datatype to built-in function. Arg#2”.
Changed the variable FLAG from type logical to type integer.
Original Description Information:
(name, flag )
Description:
Modifies the current setting of the group selectable flag.
Input:
STRING
name[]
Group name.
LOGICAL
flag
TRUE/FALSE if selectable or not.
Output:
INTEGER
<Return Value>
See error returned.
Error Conditions:
None.
Remarks:
None.
Example:
None.
 
New Description Information:
(name, flag )
Description:
Modifies the current setting of the group selectable flag.
Input:
STRING
name[]
Group name.
INTEGER
flag
0 or 1 if selectable or not.
Output:
INTEGER
<Return Value>
See error returned.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Modified
Output values were modified.
Modified function description to include new output values.
Original Description Information:
sgm_db_get_iges_in_group
(groupid, typecode, entityids, count )
Description:
Get all the IGES entity types in a group.
Input:
INTEGER
groupId
The ID of the group.
INTEGER
typecode
The Type Code from geometry_types.i.
Output:
INTEGER
entityids()
The Entity IDs.
INTEGER
<Return Value>
SUCCESS or an error code.
Error Conditions:
.38000617
ERROR Retrieving geometric entity definition of type PDA %A% from the database.
Examples:
#define MSG_SGM_IGES_EXPORT_DB_ERROR_IGES_ENTITY 38000618
#define MSG_FATAL       4
 
LOGICAL all_groups
INTEGER iges_line, lineid(VIRTUAL), istat, num110, min_cycle, blob
INTEGER nww2, nww1, nwords
 
			nwords = num110
			sys_allocate_array( lineid, 1, nwords)
/*
 *  Get all IGES line IDs from the database in the group
 */
			istat = sgm_db_get_iges_in_group( groups(ng), iges_line, ival(lineid))
			IF ( istat != 0 ) THEN
			IF ( nww2 > 0 ) 	 mem_release ( blob )
 			IF ( nww1 > 0 )  mem_release ( lineid )
			msg_to_form (  MSG_SGM_IGES_EXPORT_DB_ERROR_IGES_ENTITY, MSG_FATAL, @
									appcode(istat), 0, 1.0, “Line”)
			IF ( ! all_groups) app_pcntcomplete_close ( min_cycle, num110)
 
New Description Information:
sgm_db_get_iges_in_group
(groupid, typecode, entityids, count )
Description:
This function will get all the IGES entity types in a group.
Input:
INTEGER
groupid
This value specifies the ID of the group.
INTEGER
typecode
This value specifies the type code of the group. See the remarks below.
Output:
INTEGER
entityids()
This value returns the entity ID values. This array must be allocated with enough offsets to list all of the entity ID values assigned to the group. Use a call to the PCL function sgm_db_count_iges_in_group() to get a count of the number of offsets required.
INTEGER
id_count
This value returns the number of ID values of the specified type returned by the value entityids.
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:
.38000617
ERROR Retrieving geometric entity definition of type PDA %A% from the database.
Examples:
None.