CaeGroupCollection Class — NXOpen Python API Reference 12.0.0 documentation

# CaeGroupCollection Class

class `NXOpen.CAE.``CaeGroupCollection`

  Bases: `object`

  Provides methods for managing set `NXOpen.CAE.CaeGroup`

  To obtain an instance of this class, refer to `NXOpen.CAE.CaePart`

  New in version NX6.0.0.

# Methods

Method | Description
--- | ---
CopyGroup | Copies the input group, which must come from the same part as the collection.
CreateAutoGroups | Auto group CAE entities based on attributes Types (attribute types) by which auto grouping needs to be done should be specified using the JA CAE_GROUP_COLLECTION_auto_group_types structure.
CreateExclusiveOrGroup | Create a XOR of Groups
CreateGroup | Create a Group
CreateGroupByBoundaryBuilder | Creates element group representing volume.
CreateGroupFromEntityIds | Create a Node/Element Group from node/element IDs
CreateGroupHidden | Create a Hidden Group This Group is not seen in the navigator or the Group Manager UI.
CreateIntersectionGroup | Create a Intersection of Groups
CreateOutputGroup | Create a Output Group
CreateSubtractGroup | Create a Subtraction of two Groups
CreateUnionGroup | Create a Union of Groups
FindObject | Finds the `NXOpen.CAE.CaeGroup` with the given identifier as recorded in a journal.
QueryGroupList | Query Groups list

# Enumerations

CaeGroupCollectionEntityType Enumeration | Entity type

# Structs

CaeGroupCollectionAutoGroupErrorCodes_Struct Struct | Contains list of error codes for each auto group type
CaeGroupCollectionAutoGroupSeedNames_Struct Struct | Contains the prefix seed names to be given to auto created groups by type If a seed value is passed as NULL, then the auto created groups by that type will be given a default prefix List of default prefixes are as follows: MAT- for material_seed PPT- for ppt_seed Color- for color_seed XSECT- for section_seed LAM- for laminate seed DIM- for dimension seed FE_TYPE- for meshcolltype_seed ACROSS- for connected across assembly component seed
CaeGroupCollectionAutoGroupTypes_Struct Struct | Contains information about the types by which we do auto grouping

# Method Detail

## CopyGroup

`CaeGroupCollection.``CopyGroup`

  Copies the input group, which must come from the same part as the collection.

  Signature `CopyGroup(setName, sourceGroup)`

  Parameters:

  - setName (str) – New group name, if no name is input or the input name is invalid, a name will be generated.
  - sourceGroup (`NXOpen.CAE.CaeGroup`) – must come from the same part as the collection

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateAutoGroups

`CaeGroupCollection.``CreateAutoGroups`

  Overloaded method CreateAutoGroups

  - `CreateAutoGroups(autoGroupTypes, autoGroupSeeds)`
  - `CreateAutoGroups(ptMeshes, autoGroupTypes, autoGroupSeeds)`

  `-------------------------------------`

  Auto group CAE entities based on attributes Types (attribute types) by which auto grouping needs to be done should be specified using the JA CAE_GROUP_COLLECTION_auto_group_types structure. The number of auto created groups and the array of auto created groups will be returned. Errors if any are returned by auto group type through the JA CAE_GROUP_COLLECTION_auto_group_error_codes structure.

  Signature `CreateAutoGroups(autoGroupTypes, autoGroupSeeds)`

  Parameters:

  - autoGroupTypes (`NXOpen.CAE.CaeGroupCollectionAutoGroupTypes_Struct`) – types specifying which attributes to group by
  - autoGroupSeeds (`NXOpen.CAE.CaeGroupCollectionAutoGroupSeedNames_Struct`) – prefix seed names for auto created groups by type. If this argument is NULL or if any seed name is NULL, default prefixes are given

  Returns: | a tuple
  Return type: | A tuple consisting of (errorCodes, autoGroups). errorCodes is a `NXOpen.CAE.CaeGroupCollectionAutoGroupErrorCodes_Struct`. list of generated error codes for each auto group type autoGroups is a list of `NXOpen.CAE.CaeGroup`. output array of auto created groups

  New in version NX7.5.1.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

  Auto group CAE entities based on attributes Types (attribute types) by which auto grouping needs to be done should be specified using the JA CAE_GROUP_COLLECTION_auto_group_types structure. The number of auto created groups and the array of auto created groups will be returned. Errors if any are returned by auto group type through the JA CAE_GROUP_COLLECTION_auto_group_error_codes structure.

  Signature `CreateAutoGroups(ptMeshes, autoGroupTypes, autoGroupSeeds)`

  Parameters:

  - ptMeshes (list of `NXOpen.CAE.Mesh`) –
  - autoGroupTypes (`NXOpen.CAE.CaeGroupCollectionAutoGroupTypes_Struct`) – types specifying which attributes to group by
  - autoGroupSeeds (`NXOpen.CAE.CaeGroupCollectionAutoGroupSeedNames_Struct`) – prefix seed names for auto created groups by type. If this argument is NULL or if any seed name is NULL, default prefixes are given

  Returns: | a tuple
  Return type: | A tuple consisting of (errorCodes, autoGroups). errorCodes is a `NXOpen.CAE.CaeGroupCollectionAutoGroupErrorCodes_Struct`. list of generated error codes for each auto group type autoGroups is a list of `NXOpen.CAE.CaeGroup`. output array of auto created groups

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

  `-------------------------------------`

## CreateExclusiveOrGroup

`CaeGroupCollection.``CreateExclusiveOrGroup`

  Create a XOR of Groups

  Signature `CreateExclusiveOrGroup(setName, objects)`

  Parameters:

  - setName (str) – Name of the exclusive or group. If no name is input or the input name is invalid, a name will be generated.
  - objects (list of `NXOpen.CAE.CaeGroup`) –

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateGroup

`CaeGroupCollection.``CreateGroup`

  Overloaded method CreateGroup

  - `CreateGroup(setName, objects)`
  - `CreateGroup(setName, label, objects)`

  `-------------------------------------`

  Create a Group

  Signature `CreateGroup(setName, objects)`

  Parameters:

  - setName (str) – Name of a Set
  - objects (list of `NXOpen.TaggedObject`) –

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

  Create a Group

  Signature `CreateGroup(setName, label, objects)`

  Parameters:

  - setName (str) – Name of a Set
  - label (int) – The group label must be >=0 and be unique
  - objects (list of `NXOpen.TaggedObject`) –

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

## CreateGroupByBoundaryBuilder

`CaeGroupCollection.``CreateGroupByBoundaryBuilder`

  Creates element group representing volume.

  Signature `CreateGroupByBoundaryBuilder()`

  Returns: |
  Return type: | `NXOpen.CAE.GroupByBoundaryBuilder`

  New in version NX10.0.2.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## CreateGroupFromEntityIds

`CaeGroupCollection.``CreateGroupFromEntityIds`

  Create a Node/Element Group from node/element IDs

  Signature `CreateGroupFromEntityIds(setName, entityType, entityID)`

  Parameters:

  - setName (str) – Name of a Set
  - entityType (`NXOpen.CAE.CaeGroupCollectionEntityType`) –
  - entityID (list of int) –

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateGroupHidden

`CaeGroupCollection.``CreateGroupHidden`

  Create a Hidden Group This Group is not seen in the navigator or the Group Manager UI.

  This Group is only available within the part it was created (e.g., it is not occurrenced). This Group is not visible via enumeration methods of the `NXOpen.CAE.CaeGroupCollection`. This is a Group that can be referenced by a UDOBJ using a link_type == 3. Applications can use it to store and manage references to anything that can be managed by a `NXOpen.CAE.CaeGroup`. Whenever the part that holds onto this group is loaded, this Hidden Group will be destroyed from the part if there are no references to it.

  Signature `CreateGroupHidden(objects)`

  Parameters: | objects (list of `NXOpen.TaggedObject`) –
  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX11.0.2.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateIntersectionGroup

`CaeGroupCollection.``CreateIntersectionGroup`

  Create a Intersection of Groups

  Signature `CreateIntersectionGroup(setName, objects)`

  Parameters:

  - setName (str) – Name of the Intersection group. If no name is input or the input name is invalid, a name will be generated.
  - objects (list of `NXOpen.CAE.CaeGroup`) –

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateOutputGroup

`CaeGroupCollection.``CreateOutputGroup`

  Create a Output Group

  Signature `CreateOutputGroup(objects)`

  Parameters: | objects (list of `NXOpen.TaggedObject`) –
  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateSubtractGroup

`CaeGroupCollection.``CreateSubtractGroup`

  Create a Subtraction of two Groups

  Signature `CreateSubtractGroup(setName, fromGroup, excludedGroup)`

  Parameters:

  - setName (str) – Name of the subtraction group. If no name is input or the input name is invalid, a name will be generated.
  - fromGroup (`NXOpen.CAE.CaeGroup`) – The Set that will be substracted
  - excludedGroup (`NXOpen.CAE.CaeGroup`) – The Set that will be used for substraction

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## CreateUnionGroup

`CaeGroupCollection.``CreateUnionGroup`

  Create a Union of Groups

  Signature `CreateUnionGroup(setName, objects)`

  Parameters:

  - setName (str) – Name of the Union group. If no name is input or the input name is invalid, a name will be generated.
  - objects (list of `NXOpen.CAE.CaeGroup`) –

  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## FindObject

`CaeGroupCollection.``FindObject`

  Finds the `NXOpen.CAE.CaeGroup` with the given identifier as recorded in a journal.

  An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

  An exception will be thrown if no object can be found with the given journal identifier.

  Signature `FindObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Identifier of the Set you want
  Returns: |
  Return type: | `NXOpen.CAE.CaeGroup`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## QueryGroupList

`CaeGroupCollection.``QueryGroupList`

  Query Groups list

  Signature `QueryGroupList()`

  Returns: |
  Return type: | list of `NXOpen.TaggedObject`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)