NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::CAE::CaeGroupCollection Class Reference

Provides methods for managing set CAE::CaeGroup. More...

Inheritance diagram for NXOpen::CAE::CaeGroupCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

struct  AutoGroupErrorCodes
 Contains list of error codes for each auto group type. More...
struct  AutoGroupSeedNames
 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. More...
struct  AutoGroupTypes
 Contains information about the types by which we do auto grouping. More...
class  iterator
 Iterator for accessing the contents of the collection. More...

Public Types

enum  EntityType { EntityTypeNode, EntityTypeElement }
 Entity type. More...

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element.
NXOpen::CAE::CaeGroupCopyGroup (const NXString &setName, NXOpen::CAE::CaeGroup *sourceGroup)
 Copies the input group, which must come from the same part as the collection.
NXOpen::CAE::CaeGroupCollection::AutoGroupErrorCodes CreateAutoGroups (const NXOpen::CAE::CaeGroupCollection::AutoGroupTypes &autoGroupTypes, const NXOpen::CAE::CaeGroupCollection::AutoGroupSeedNames &autoGroupSeeds, std::vector< NXOpen::CAE::CaeGroup * > &autoGroups)
 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.
NXOpen::CAE::CaeGroupCreateExclusiveOrGroup (const NXString &setName, const std::vector< NXOpen::CAE::CaeGroup * > &objects)
 Create a XOR of Groups.
NXOpen::CAE::CaeGroupCreateGroup (const NXString &setName, const std::vector< NXOpen::TaggedObject * > &objects)
 Create a Group.
NXOpen::CAE::CaeGroupCreateGroupFromEntityIds (const NXString &setName, NXOpen::CAE::CaeGroupCollection::EntityType entityType, const std::vector< int > &entityID)
 Create a Node/Element Group from node/element IDs.
NXOpen::CAE::CaeGroupCreateIntersectionGroup (const NXString &setName, const std::vector< NXOpen::CAE::CaeGroup * > &objects)
 Create a Intersection of Groups.
NXOpen::CAE::CaeGroupCreateOutputGroup (const std::vector< NXOpen::TaggedObject * > &objects)
 Create a Output Group.
NXOpen::CAE::CaeGroupCreateSubtractGroup (const NXString &setName, NXOpen::CAE::CaeGroup *fromGroup, NXOpen::CAE::CaeGroup *excludedGroup)
 Create a Subtraction of two Groups.
NXOpen::CAE::CaeGroupCreateUnionGroup (const NXString &setName, const std::vector< NXOpen::CAE::CaeGroup * > &objects)
 Create a Union of Groups.
iterator end ()
 Returns an iterator addressing one past the last element.
NXOpen::CAE::CaeGroupFindObject (const NXString &journalIdentifier)
 Finds the CAE::CaeGroup with the given identifier as recorded in a journal.
void QueryGroupList (std::vector< NXOpen::TaggedObject * > &objects)
 Query Groups list
Created in NX6.0.0.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Provides methods for managing set CAE::CaeGroup.


To obtain an instance of this class, refer to CAE::CaePart

Created in NX6.0.0.


Member Enumeration Documentation

Entity type.

Enumerator:
EntityTypeNode 

node

EntityTypeElement 

element


Member Function Documentation

Returns an iterator addressing the first element.

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

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameNew group name, if no name is input or the input name is invalid, a name will be generated.
NOTE: The full Unicode character set is not supported for this parameter.
sourceGroupmust come from the same part as the collection

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.

Returns:
list of generated error codes for each auto group type
Created in NX7.5.1.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
autoGroupTypestypes specifying which attributes to group by
autoGroupSeedsprefix seed names for auto created groups by type. If this argument is NULL or if any seed name is NULL, default prefixes are given
autoGroupsoutput array of auto created groups

Create a XOR of Groups.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameName of the exclusive or group. If no name is input or the input name is invalid, a name will be generated.
NOTE: The full Unicode character set is not supported for this parameter.
objectsobjects
NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroup ( const NXString setName,
const std::vector< NXOpen::TaggedObject * > &  objects 
)

Create a Group.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameName of a Set
NOTE: The full Unicode character set is not supported for this parameter.
objectsobjects

Create a Node/Element Group from node/element IDs.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameName of a Set
NOTE: The full Unicode character set is not supported for this parameter.
entityTypeentitytype
entityIDentityid

Create a Intersection of Groups.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameName of the Intersection group. If no name is input or the input name is invalid, a name will be generated.
NOTE: The full Unicode character set is not supported for this parameter.
objectsobjects

Create a Output Group.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
objectsobjects

Create a Subtraction of two Groups.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameName of the subtraction group. If no name is input or the input name is invalid, a name will be generated.
NOTE: The full Unicode character set is not supported for this parameter.
fromGroupThe Set that will be substracted
excludedGroupThe Set that will be used for substraction
NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateUnionGroup ( const NXString setName,
const std::vector< NXOpen::CAE::CaeGroup * > &  objects 
)

Create a Union of Groups.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
setNameName of the Union group. If no name is input or the input name is invalid, a name will be generated.
NOTE: The full Unicode character set is not supported for this parameter.
objectsobjects

Returns an iterator addressing one past the last element.

Finds the 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.

Returns:

Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters:
journalIdentifierIdentifier of the Set you want

Query Groups list
Created in NX6.0.0.



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

Parameters:
objectsobjects

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.