SelectionRecipeCollection Class

class NXOpen.CAE.SelectionRecipeCollection

Bases: object

Provides methods for managing Selection Recipes NXOpen.CAE.SelectionRecipe

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

New in version NX12.0.0.

Methods

Method Description
Copy Copies a Selection Recipe with all attributes and add it to the collection.
CreateAttributeRecipe Creates an Attribute based Selection Recipe
CreateBoxBoundingVolumeRecipe Create a Bounding Volume Selection Recipe
CreateCoordinateRecipe Creates a Coordinate based Single Node Selection Recipe
CreateCylinderBoundingVolumeRecipe Create a Bounding Volume Selection Recipe
CreateLabelRangeRecipe Creates a Label Range Selection Recipe
CreatePointRecipe Creates a Point based Single Node Selection Recipe
CreateSingleLabelRecipe Creates a Single Node Label Selection Recipe
CreateSphereBoundingVolumeRecipe Create a Bounding Volume Selection Recipe
Delete Delete a list of selection recipes
FindObject Finds the NXOpen.CAE.SelectionRecipe with the given identifier as recorded in a journal.

Method Detail

Copy

SelectionRecipeCollection.Copy

Copies a Selection Recipe with all attributes and add it to the collection.

This method gives proper unique name to the created Selection Recipe.

Signature Copy(recipeToCopy, name)

Parameters:
  • recipeToCopy (NXOpen.CAE.SelectionRecipe) –
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
Returns:
Return type:

NXOpen.CAE.SelectionRecipe

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

CreateAttributeRecipe

SelectionRecipeCollection.CreateAttributeRecipe

Creates an Attribute based Selection Recipe

Signature CreateAttributeRecipe(name, entityType, resolveRelatedFeEntity, relatedFeEntityType)

Parameters:
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
  • entityType (NXOpen.CAE.CaeSetGroupFilterType) – The main enitity type to which the recipe resolves to.
  • resolveRelatedFeEntity (bool) – Resolve to FE entity type related to main entity type.
  • relatedFeEntityType (NXOpen.CAE.CaeSetGroupFilterType) – The FE enitity type related to the main entity type. Recipe will only resolve to the FE entity type, not the main entity type.
Returns:
Return type:

NXOpen.CAE.AttributeSelectionRecipe

New in version NX12.0.0.

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

CreateBoxBoundingVolumeRecipe

SelectionRecipeCollection.CreateBoxBoundingVolumeRecipe

Overloaded method CreateBoxBoundingVolumeRecipe

  • CreateBoxBoundingVolumeRecipe(name, centerCsys, length, width, height, entityTypes)
  • CreateBoxBoundingVolumeRecipe(name, centerPoint, targetPoint, entityTypes)

-------------------------------------

Create a Bounding Volume Selection Recipe

Signature CreateBoxBoundingVolumeRecipe(name, centerCsys, length, width, height, entityTypes)

Parameters:
Returns:
Return type:

NXOpen.CAE.BoundingVolumeSelectionRecipe

New in version NX12.0.0.

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

-------------------------------------

Create a Bounding Volume Selection Recipe

Signature CreateBoxBoundingVolumeRecipe(name, centerPoint, targetPoint, entityTypes)

Parameters:
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
  • centerPoint (NXOpen.Point) –
  • targetPoint (NXOpen.Point) –
  • entityTypes (list of NXOpen.CAE.CaeSetGroupFilterType) – Entity types to which this recipe resolves to. If None default will be Nodes
Returns:
Return type:

NXOpen.CAE.BoundingVolumeSelectionRecipe

New in version NX12.0.0.

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

-------------------------------------

CreateCoordinateRecipe

SelectionRecipeCollection.CreateCoordinateRecipe

Creates a Coordinate based Single Node Selection Recipe

Signature CreateCoordinateRecipe(name, coordinates, tolerance)

Parameters:
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
  • coordinates (NXOpen.Point3d) – The coordinates to be used in the search.
  • tolerance (float) – The search tolerance.
Returns:
Return type:

NXOpen.CAE.CoordinateSelectionRecipe

New in version NX12.0.0.

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

CreateCylinderBoundingVolumeRecipe

SelectionRecipeCollection.CreateCylinderBoundingVolumeRecipe

Overloaded method CreateCylinderBoundingVolumeRecipe

  • CreateCylinderBoundingVolumeRecipe(name, centerCsys, diameter, cylinderHeight, entityTypes)
  • CreateCylinderBoundingVolumeRecipe(name, diameter, baseCenter, topCenter, entityTypes)

-------------------------------------

Create a Bounding Volume Selection Recipe

Signature CreateCylinderBoundingVolumeRecipe(name, centerCsys, diameter, cylinderHeight, entityTypes)

Parameters:
Returns:
Return type:

NXOpen.CAE.BoundingVolumeSelectionRecipe

New in version NX12.0.0.

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

-------------------------------------

Create a Bounding Volume Selection Recipe

Signature CreateCylinderBoundingVolumeRecipe(name, diameter, baseCenter, topCenter, entityTypes)

Parameters:
Returns:
Return type:

NXOpen.CAE.BoundingVolumeSelectionRecipe

New in version NX12.0.0.

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

-------------------------------------

CreateLabelRangeRecipe

SelectionRecipeCollection.CreateLabelRangeRecipe

Creates a Label Range Selection Recipe

Signature CreateLabelRangeRecipe(name, singleLabels, startLabels, endLabels, increments, entityType)

Parameters:
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
  • singleLabels (list of int) –
  • startLabels (list of int) –
  • endLabels (list of int) –
  • increments (list of int) –
  • entityType (NXOpen.CAE.CaeSetGroupFilterType) –
Returns:
Return type:

NXOpen.CAE.LabelRangeSelectionRecipe

New in version NX12.0.0.

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

CreatePointRecipe

SelectionRecipeCollection.CreatePointRecipe

Creates a Point based Single Node Selection Recipe

Signature CreatePointRecipe(name, point, tolerance)

Parameters:
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
  • point (NXOpen.Point) – The point whom coordinates will be used in the search.
  • tolerance (float) – The search tolerance.
Returns:
Return type:

NXOpen.CAE.PointSelectionRecipe

New in version NX12.0.0.

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

CreateSingleLabelRecipe

SelectionRecipeCollection.CreateSingleLabelRecipe

Creates a Single Node Label Selection Recipe

Signature CreateSingleLabelRecipe(name, nodeLabel)

Parameters:
  • name (str) – Name of the selection recipe. If None, then a valid unique name will be generated.
  • nodeLabel (int) – The label of the node to which the recipe resolves to.
Returns:
Return type:

NXOpen.CAE.SingleLabelSelectionRecipe

New in version NX12.0.0.

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

CreateSphereBoundingVolumeRecipe

SelectionRecipeCollection.CreateSphereBoundingVolumeRecipe

Create a Bounding Volume Selection Recipe

Signature CreateSphereBoundingVolumeRecipe(name, centerPoint, diameter, entityTypes)

Parameters:
Returns:
Return type:

NXOpen.CAE.BoundingVolumeSelectionRecipe

New in version NX12.0.0.

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

Delete

SelectionRecipeCollection.Delete

Delete a list of selection recipes

Signature Delete(recipes)

Parameters:recipes (list of NXOpen.CAE.SelectionRecipe) – The recipes to be deleted

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

FindObject

SelectionRecipeCollection.FindObject

Finds the NXOpen.CAE.SelectionRecipe 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.SelectionRecipe

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)