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

Inheritance diagram for NXOpen::CAE::CaeGroupCollection:

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 ACROSS- for connected across assembly component 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. More...

NXOpen::CAE::CaeGroup *	CopyGroup (const NXString &setName, NXOpen::CAE::CaeGroup *sourceGroup)
	Copies the input group, which must come from the same part as the collection. More...

NXOpen::CAE::CaeGroup *	CopyGroup (const char setName, NXOpen::CAE::CaeGroup sourceGroup)
	Copies the input group, which must come from the same part as the collection. More...

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. More...

NXOpen::CAE::CaeGroupCollection::AutoGroupErrorCodes	CreateAutoGroups (const std::vector< NXOpen::CAE::Mesh * > &ptMeshes, 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. More...

NXOpen::CAE::CaeGroup *	CreateExclusiveOrGroup (const NXString &setName, const std::vector< NXOpen::CAE::CaeGroup * > &objects)
	Create a XOR of Groups. More...

NXOpen::CAE::CaeGroup *	CreateExclusiveOrGroup (const char setName, const std::vector< NXOpen::CAE::CaeGroup > &objects)
	Create a XOR of Groups. More...

NXOpen::CAE::CaeGroup *	CreateGroup (const NXString &setName, const std::vector< NXOpen::TaggedObject * > &objects)
	Create a Group. More...

NXOpen::CAE::CaeGroup *	CreateGroup (const char setName, const std::vector< NXOpen::TaggedObject > &objects)
	Create a Group. More...

NXOpen::CAE::CaeGroup *	CreateGroup (const NXString &setName, int label, const std::vector< NXOpen::TaggedObject * > &objects)
	Create a Group. More...

NXOpen::CAE::CaeGroup *	CreateGroup (const char setName, int label, const std::vector< NXOpen::TaggedObject > &objects)
	Create a Group. More...

NXOpen::CAE::GroupByBoundaryBuilder *	CreateGroupByBoundaryBuilder ()
	Creates element group representing volume. More...

NXOpen::CAE::CaeGroup *	CreateGroupFromEntityIds (const NXString &setName, NXOpen::CAE::CaeGroupCollection::EntityType entityType, const std::vector< int > &entityID)
	Create a Node/Element Group from node/element IDs. More...

NXOpen::CAE::CaeGroup *	CreateGroupFromEntityIds (const char *setName, NXOpen::CAE::CaeGroupCollection::EntityType entityType, const std::vector< int > &entityID)
	Create a Node/Element Group from node/element IDs. More...

NXOpen::CAE::CaeGroup *	CreateGroupHidden (const std::vector< NXOpen::TaggedObject * > &objects)
	Create a Hidden Group This Group is not seen in the navigator or the Group Manager UI. More...

NXOpen::CAE::CaeGroup *	CreateIntersectionGroup (const NXString &setName, const std::vector< NXOpen::CAE::CaeGroup * > &objects)
	Create a Intersection of Groups. More...

NXOpen::CAE::CaeGroup *	CreateIntersectionGroup (const char setName, const std::vector< NXOpen::CAE::CaeGroup > &objects)
	Create a Intersection of Groups. More...

NXOpen::CAE::CaeGroup *	CreateOutputGroup (const std::vector< NXOpen::TaggedObject * > &objects)
	Create a Output Group. More...

NXOpen::CAE::CaeGroup *	CreateSubtractGroup (const NXString &setName, NXOpen::CAE::CaeGroup fromGroup, NXOpen::CAE::CaeGroup excludedGroup)
	Create a Subtraction of two Groups. More...

NXOpen::CAE::CaeGroup *	CreateSubtractGroup (const char setName, NXOpen::CAE::CaeGroup fromGroup, NXOpen::CAE::CaeGroup *excludedGroup)
	Create a Subtraction of two Groups. More...

NXOpen::CAE::CaeGroup *	CreateUnionGroup (const NXString &setName, const std::vector< NXOpen::CAE::CaeGroup * > &objects)
	Create a Union of Groups. More...

NXOpen::CAE::CaeGroup *	CreateUnionGroup (const char setName, const std::vector< NXOpen::CAE::CaeGroup > &objects)
	Create a Union of Groups. More...

iterator	end ()
	Returns an iterator addressing one past the last element. More...

NXOpen::CAE::CaeGroup *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::CAE::CaeGroup with the given identifier as recorded in a journal. More...

NXOpen::CAE::CaeGroup *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::CAE::CaeGroup with the given identifier as recorded in a journal. More...

void	QueryGroupList (std::vector< NXOpen::TaggedObject * > &objects)
	Query Groups list Created in NX6.0.0. More...

tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

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

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::CaeGroupCollection::EntityType

Entity type.

Enumerator
EntityTypeNode	node
EntityTypeElement	element

Member Function Documentation

iterator NXOpen::CAE::CaeGroupCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CopyGroup	(	const NXString &	setName,
		NXOpen::CAE::CaeGroup *	sourceGroup
	)

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

setName	New group name, if no name is input or the input name is invalid, a name will be generated.
sourceGroup	must come from the same part as the collection

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CopyGroup	(	const char *	setName,
		NXOpen::CAE::CaeGroup *	sourceGroup
	)

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

setName	New group name, if no name is input or the input name is invalid, a name will be generated.
sourceGroup	must come from the same part as the collection

NXOpen::CAE::CaeGroupCollection::AutoGroupErrorCodes NXOpen::CAE::CaeGroupCollection::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.

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

autoGroupTypes	types specifying which attributes to group by
autoGroupSeeds	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
autoGroups	output array of auto created groups

NXOpen::CAE::CaeGroupCollection::AutoGroupErrorCodes NXOpen::CAE::CaeGroupCollection::CreateAutoGroups	(	const std::vector< NXOpen::CAE::Mesh * > &	ptMeshes,
		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.

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 NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

ptMeshes	ptmeshes
autoGroupTypes	types specifying which attributes to group by
autoGroupSeeds	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
autoGroups	output array of auto created groups

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateExclusiveOrGroup	(	const NXString &	setName,
		const std::vector< NXOpen::CAE::CaeGroup * > &	objects
	)

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

setName	Name of the exclusive or group. If no name is input or the input name is invalid, a name will be generated.
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateExclusiveOrGroup	(	const char *	setName,
		const std::vector< NXOpen::CAE::CaeGroup * > &	objects
	)

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

setName	Name of the exclusive or group. If no name is input or the input name is invalid, a name will be generated.
objects	objects

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

setName	Name of a Set
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroup	(	const char *	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

setName	Name of a Set
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroup	(	const NXString &	setName,
		int	label,
		const std::vector< NXOpen::TaggedObject * > &	objects
	)

Create a Group.

Returns: Created in NX12.0.0.

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

Parameters

setName	Name of a Set
label	The group label must be >=0 and be unique
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroup	(	const char *	setName,
		int	label,
		const std::vector< NXOpen::TaggedObject * > &	objects
	)

Create a Group.

Returns: Created in NX12.0.0.

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

Parameters

setName	Name of a Set
label	The group label must be >=0 and be unique
objects	objects

NXOpen::CAE::GroupByBoundaryBuilder* NXOpen::CAE::CaeGroupCollection::CreateGroupByBoundaryBuilder ( )

Creates element group representing volume.

Returns: Created in NX10.0.2.

License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroupFromEntityIds	(	const NXString &	setName,
		NXOpen::CAE::CaeGroupCollection::EntityType	entityType,
		const std::vector< int > &	entityID
	)

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

setName	Name of a Set
entityType	entitytype
entityID	entityid

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroupFromEntityIds	(	const char *	setName,
		NXOpen::CAE::CaeGroupCollection::EntityType	entityType,
		const std::vector< int > &	entityID
	)

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

setName	Name of a Set
entityType	entitytype
entityID	entityid

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateGroupHidden ( const std::vector< NXOpen::TaggedObject * > & objects )

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.

Returns: Created in NX11.0.2.

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

Parameters

objects objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateIntersectionGroup	(	const NXString &	setName,
		const std::vector< NXOpen::CAE::CaeGroup * > &	objects
	)

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

setName	Name of the Intersection group. If no name is input or the input name is invalid, a name will be generated.
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateIntersectionGroup	(	const char *	setName,
		const std::vector< NXOpen::CAE::CaeGroup * > &	objects
	)

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

setName	Name of the Intersection group. If no name is input or the input name is invalid, a name will be generated.
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateOutputGroup ( const std::vector< NXOpen::TaggedObject * > & objects )

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

objects objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateSubtractGroup	(	const NXString &	setName,
		NXOpen::CAE::CaeGroup *	fromGroup,
		NXOpen::CAE::CaeGroup *	excludedGroup
	)

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

setName	Name of the subtraction group. If no name is input or the input name is invalid, a name will be generated.
fromGroup	The Set that will be substracted
excludedGroup	The Set that will be used for substraction

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateSubtractGroup	(	const char *	setName,
		NXOpen::CAE::CaeGroup *	fromGroup,
		NXOpen::CAE::CaeGroup *	excludedGroup
	)

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

setName	Name of the subtraction group. If no name is input or the input name is invalid, a name will be generated.
fromGroup	The Set that will be substracted
excludedGroup	The 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

setName	Name of the Union group. If no name is input or the input name is invalid, a name will be generated.
objects	objects

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::CreateUnionGroup	(	const char *	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

setName	Name of the Union group. If no name is input or the input name is invalid, a name will be generated.
objects	objects

iterator NXOpen::CAE::CaeGroupCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::FindObject ( const NXString & journalIdentifier )

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.

Returns: Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

journalIdentifier Identifier of the Set you want

NXOpen::CAE::CaeGroup* NXOpen::CAE::CaeGroupCollection::FindObject ( const char * journalIdentifier )

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.

Returns: Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

journalIdentifier Identifier of the Set you want

void NXOpen::CAE::CaeGroupCollection::QueryGroupList ( std::vector< NXOpen::TaggedObject * > & objects )

Query Groups list
Created in NX6.0.0.

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

Parameters

objects objects

tag_t NXOpen::CAE::CaeGroupCollection::Tag ( ) const

Returns the tag of this object.

The documentation for this class was generated from the following file:

CAE_CaeGroupCollection.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation