Tutorial Toolkit Function Descriptions > Group > Graphics Application
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Graphics Application
Functions to manage graphical attributes of groups.
 
ga_groups_load_vector_set
( ngroups, group_ids, vector_id )
 
Description:
Changes the current load vector table associated with multiple groups.
Input:
INTEGER
ngroups
Number of groups.
INTEGER
group_ids ( )
Groups to assign vector table to.
INTEGER
vector_id
Load vector id.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000143
The specified vector result table was not found.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_groups_load_vector_set, 491 and ga_groups_load_vector_set (p. 494) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_color_get
( name, color )
Description:
Gets the current color associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
color
Color of group (0-15).
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_color_get (p. 430) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_color_set
( name, color )
  
Description:
Modifies the current color associated with a group.
Input:
STRING
name[]
Group name.
INTEGER
color
Color id (0-15).
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_color_set (p. 431) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_current_get
( name )
Description:
Get the current group.
Input:
none
Output:
STRING
name[]
Group name.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000121
There is not a current group defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_current_get (p. 433) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_deform_get
( name, flag )
Description:
Gets the deform flag associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
Deform flag.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
Example:
Please see ga_group_deform_get (p. 434) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_deform_set
( name, flag )
Description:
Sets whether a deform plot should be displayed.
Input:
STRING
name[]
Group name.
INTEGER
flag
If Flag=1 display deform plot, If Flag=0 don’t display.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
Example:
Please see ga_group_deform_set (p. 435) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_display_get
( name, dname )
Description:
Gets the name of the current display property list associated with a group.
Input:
STRING
name[]
Group name.
Output:
STRING
dname[]
Name of the display property list.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000118
There is no display property posted to the group.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_display_get (p. 437) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_elem_scalar_get
( name, scalar_id )
  
Description:
Gets the scalar table associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
scalar_id
Scalar id.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_elem_scalar_get (p. 438) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_elem_scalar_set
( name, scalar_id )
Description:
Changes the current element scalar table associated with a group.
Input:
STRING
name[]
Group name.
INTEGER
scalar_id
Element scalar id.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000137
The specified element scalar table was not found.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_elem_scalar_set (p. 440) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_entities_get
( name, type, range, number, entities )
Description:
Gets a sorted list of the entities contained in a group.
Input:
STRING
name[]
Group name.
INTEGER
type
Entity type.
INTEGER
range (3)
Id range of members to return (1,2) and (3) max size of conversion string.
INTEGER
number
Number of entities in group.
Output:
STRING
entities[]
Entity labels.
INTEGER
<Return Value>
See error conditions.
Comments:
Called from PCL ( uil_group_modify.pcl, uil_group_modify_members.pcl, uil_group_show_members).
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000127
The group does not have any entities in it.
Example:
Please see ga_group_entities_get (p. 442) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_exist_get
( name, flag )
Description:
Determines if a group with the specified name exists.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
Existence flag.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_exist_get (p. 444) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_groups_get
( group_list )
Description:
This function will get a list of the currently defined groups.
Input:
none
Output:
STRING
group_list [ ] ()
List of groups.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
#
#  Purpose          :  This file gives an example of a call to the
#                      function ga_group_groups_get()
#
#                      This function gets the list of all the groups.
#                      This file opens a database spool.db which has
#                      two groups “default_group”and “fem_model”group.
#                      This file gets the list of all the groups in
#                      the database “spool.db”.
#
#                      Before running this file the database should be
#                      created by running the session file “spool.ses”
#                      To run this session file, first start
#                      a session of MSC.Patran,then run this session
#                      file by “File”,”Session”,”Play” pulldown
#                      menus on the menu bar.
#
#  The ga_group_groups_get has the following arguments:
#  ga_group_groups_get
#     ( group_list )
#  -------------------------------------------------------------------
#  Variable Declaration
#
STRING   s_group_list[32](VIRTUAL)
INTEGER  i_return_value
INTEGER  i_group_count
#  -------------------------------------------------------------------
# opening the existing database spool.db
uil_file_open.go(“spool.db”)
 
i_return_value =
   ga_group_ngroups_get
      ( i_group_count )
 
dump i_return_value
dump i_group_count
 
i_return_value =
   sys_allocate_array ( s_group_list, 1, i_group_count )
 
dump i_return_value
 
i_return_value =                                              @
   ga_group_groups_get                                        @
      ( s_group_list )
 
dump i_return_value
 
# The groups in the opened database are
dump s_group_list
 
#  -------------------------------------------------------------------
 
ga_group_label_get
( name, flag )
  
Description:
Gets the current label flag associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
Label flag.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_label_get (p. 446) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_label_set
( name, flag )
 
Description:
Sets whether labels should be displayed.
Input:
STRING
name[]
Group name.
INTEGER
flag
If Flag=1 display deform plot, If Flag=0 don’t display.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_label_set (p. 448) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_load_vector_get
( name, vector_id )
Description:
Gets the load vector table associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
vector_id
Vector id.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_load_vector_get (p. 449) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_load_vector_set
( name, vector_id )
 
Description:
Changes the current load vector table associated with a group.
Input:
STRING
name[]
Group name.
INTEGER
vector_id
Load vector id.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000143
The specified vector result table was not found.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_load_vector_set, 451, ga_group_load_vector_set, 453, and ga_group_load_vector_set (p. 455) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_nentities_get
( name, type, number )
Description:
Gets the number of entities of a particular type contained in the specified group.
Input:
STRING
name[]
Group name.
INTEGER
type
Entity type.
Output:
INTEGER
number
Number of entities.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_nentities_get (p. 458) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_ngroups_get
( group_count )
  
Description:
This function will get the number of currently defined groups.
Input:
None.
Output:
INTEGER
group_count
This value will return the number of groups that are currently defined.
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:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_groups_get (p. 445) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_node_deform_set
( name, deform_id )
Description:
Changes the current deform table associated with a group.
Input:
STRING
name[]
Group name.
INTEGER
deform_id
Node deform id.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000139
The specified nodal deformation table was not found.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_node_deform_set, 459 and ga_group_node_deform_set (p. 461) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_precision_get
( name, flag )
  
Description:
Gets the current precision flag associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
Flag=1 if high precision, Flag=0 if fast.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_precision_get (p. 463) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_result_vector_get
( name, vector_id )
Description:
Gets the result vector table associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
vector_id
Vector id.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_result_vector_get, 464 and ga_group_result_vector_get (p. 467) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_result_vector_set
( name, vector_id )
Description:
Changes the current result vector table associated with a group.
Input:
STRING
name[]
Group name.
INTEGER
vector_id
Result vector id.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000143
The specified vector result table was not found.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Pleae see ga_group_result_vector_set, 470 and ga_group_result_vector_set (p. 472) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_selectable_get
( name, flag )
Description:
Gets the current select status of a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
1 or 0 if selectable or not.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_selectable_get (p. 475) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_selectable_set
( name, flag )
Description:
Modifies the current setting of the group selectable flag.
Input:
STRING
name[]
Group name.
INTEGER
flag
1 or 0 if selectable or not.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_selectable_set (p. 477) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_style_get
( name, style )
  
Description:
Gets the render style associated with a group.
Input:
STRING
name[]
Group name.
Output:
STRING
style[]
Render style.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_style_get (p. 479) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_style_set
( name, style )
Description:
Modifies the render style associated with a group.
Input:
STRING
name[]
Group name.
STRING
style[]
Render Style.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000013
The render style is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_style_set (p. 480) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_vector_load_get
( name, style )
Description:
Gets the load vector flag associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
Vector flag.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_vector_load_get (p. 482) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_vector_load_set
( name, flag )
Description:
Flags if a load vector plot should be displayed with group.
Input:
STRING
name[]
Group name.
INTEGER
flag
If Flag=1 display vector plot, If Flag=0 don’t display.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_vector_load_set (p. 483) in the MSC Acumen Toolkit - Code Examples.
  
ga_group_vector_result_get
( name, flag )
Description:
Gets the load vector flag associated with a group.
Input:
STRING
name[]
Group name.
Output:
INTEGER
flag
Vector flag.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_vector_result_get, 485 and ga_group_vector_result_get (p. 486) in the MSC Acumen Toolkit - Code Examples.
 
ga_group_vector_result_set
( name, flag )
  
Description:
Flags if a result vector plot should be displayed with group.
Input:
STRING
name[]
Group name.
INTEGER
flag
If Flag=1 display vector plot, If Flag=0 don’t display.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000050
The group name is invalid.
11000105
The specified group was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_group_vector_result_set, 488 and ga_group_vector_result_set (p. 490) in the MSC Acumen Toolkit - Code Examples.