General

Tutorial Toolkit Function Descriptions > Group > General

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

General

General functions for managing groups in the model database.


db_get_group_name	(grp_id, name)


Description:
Retrieves the group name associated with the specified group id.
Input:
INTEGER	grp_id	Id to be retrieved from the database.
Output:
STRING	name[31]	Name of the group.
INTEGER	<Return Value>	Returns the success or failure of the routine.

Example:

Please see db_get_group_name (p. 419) in the MSC Acumen Toolkit - Code Examples.


db_count_entities_in_group	(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.

Example:

Please see db_count_entities_in_group (p. 406) in the MSC Acumen Toolkit - Code Examples.


db_count_groups_for_entity	(id, type, count)


Description:
Counts all groups in which a specified entity resides
Input:
INTEGER	id	The id of the entity for which the group count is desired.
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.

Example:

Please see db_count_groups_for_entity (p. 408) in the MSC Acumen Toolkit - Code Examples.


db_get_groups_for_entity	(id, type, count, group_list)


Description:
Gets all group ids associated with the specified entity type and id.
Input:
INTEGER	id	The id of the entity of the type specified.
INTEGER	type	The type of entity to be counted.
INTEGER	count	The number of groups for which storage has been allocated by the calling routine.
Output:
INTEGER	group_list()	Array containing the ids of the groups associated with the input id.
INTEGER	<Return Value>	Returns the success or failure of the routine.

Example:

See example for db_count_groups_for_entity, 151. See also db_get_groups_for_entity (p. 420) in the MSC Acumen Toolkit - Code Examples.


uil_entity_group_members_get	(group, entity_type, members)


Description:
Get the group’s members of a given entity type.
Input:
STRING	group[]	Name of the group from which to get the list of members.
INTEGER	entity_type	Type of entity members to get. DbTypPoint 1 DbTypCurve 2 DbTypSurface 3 DbTypSolid 4 DbTypNode 123 DbTypElem 124 DbTypMpc 161
Output:
STRING	members [VIRTUAL]
INTEGER	<Return Value>	List of group members of the given entity type. = 0, Function was successful.

Example: