NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.CAE.SelectionRecipeCollection Class Reference

Provides methods for managing Selection Recipes NXOpen.CAE.SelectionRecipe More...

Inheritance diagram for NXOpen.CAE.SelectionRecipeCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe NXOpen.CAE.SelectionRecipe Copy (NXOpen.CAE.SelectionRecipe recipeToCopy, string name)
 Copies a Selection Recipe with all attributes and add it to the collection. More...
 
unsafe
NXOpen.CAE.AttributeSelectionRecipe 
CreateAttributeRecipe (string name, NXOpen.CAE.CaeSetGroupFilterType entityType, bool resolveRelatedFeEntity, NXOpen.CAE.CaeSetGroupFilterType relatedFeEntityType)
 Creates an Attribute based Selection Recipe More...
 
unsafe
NXOpen.CAE.BoundingVolumeSelectionRecipe 
CreateBoxBoundingVolumeRecipe (string name, NXOpen.CoordinateSystem centerCsys, NXOpen.Expression length, NXOpen.Expression width, NXOpen.Expression height, NXOpen.CAE.CaeSetGroupFilterType[] entityTypes)
 Create a Bounding Volume Selection Recipe More...
 
unsafe
NXOpen.CAE.BoundingVolumeSelectionRecipe 
CreateBoxBoundingVolumeRecipe (string name, NXOpen.Point centerPoint, NXOpen.Point targetPoint, NXOpen.CAE.CaeSetGroupFilterType[] entityTypes)
 Create a Bounding Volume Selection Recipe More...
 
unsafe
NXOpen.CAE.CloneSelRecipeBuilder 
CreateCloneSelRecipeBuilder (bool deleteSourceRecipe, NXOpen.CAE.SelectionRecipe sourceSelRecipe)
 Creates a Clone Selection Recipe Builder. More...
 
unsafe
NXOpen.CAE.CoordinateSelectionRecipe 
CreateCoordinateRecipe (string name, NXOpen.Point3d coordinates, double tolerance)
 Creates a Coordinate based Single Node Selection Recipe More...
 
unsafe
NXOpen.CAE.BoundingVolumeSelectionRecipe 
CreateCylinderBoundingVolumeRecipe (string name, NXOpen.CoordinateSystem centerCsys, NXOpen.Expression diameter, NXOpen.Expression cylinderHeight, NXOpen.CAE.CaeSetGroupFilterType[] entityTypes)
 Create a Bounding Volume Selection Recipe More...
 
unsafe
NXOpen.CAE.BoundingVolumeSelectionRecipe 
CreateCylinderBoundingVolumeRecipe (string name, NXOpen.Expression diameter, NXOpen.Point baseCenter, NXOpen.Point topCenter, NXOpen.CAE.CaeSetGroupFilterType[] entityTypes)
 Create a Bounding Volume Selection Recipe More...
 
unsafe
NXOpen.CAE.LabelRangeSelectionRecipe 
CreateLabelRangeRecipe (string name, int[] singleLabels, int[] startLabels, int[] endLabels, int[] increments, NXOpen.CAE.CaeSetGroupFilterType entityType)
 Creates a Label Range Selection Recipe More...
 
unsafe
NXOpen.CAE.PointSelectionRecipe 
CreatePointRecipe (string name, NXOpen.Point point, double tolerance)
 Creates a Point based Single Node Selection Recipe More...
 
unsafe NXOpen.CAE.SelRecipeBuilder CreateSelRecipeBuilder ()
 Creates a builder for Selection Recipe More...
 
unsafe
NXOpen.CAE.SingleLabelSelectionRecipe 
CreateSingleLabelRecipe (string name, int nodeLabel)
 Creates a Single Node Label Selection Recipe More...
 
unsafe
NXOpen.CAE.BoundingVolumeSelectionRecipe 
CreateSphereBoundingVolumeRecipe (string name, NXOpen.Point centerPoint, NXOpen.Expression diameter, NXOpen.CAE.CaeSetGroupFilterType[] entityTypes)
 Create a Bounding Volume Selection Recipe More...
 
unsafe void Delete (NXOpen.CAE.SelectionRecipe[] recipes)
 Delete a list of selection recipes More...
 
unsafe NXOpen.CAE.SelectionRecipe FindObject (string journalIdentifier)
 Finds the NXOpen.CAE.SelectionRecipe with the given identifier as recorded in a journal. More...
 
NXOpen.CAE.SelectionRecipe[] ToArray ()
 Returns an array of NXOpen.CAE.SelectionRecipe objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Provides methods for managing Selection Recipes NXOpen.CAE.SelectionRecipe

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

Created in NX12.0.0

Member Function Documentation

unsafe NXOpen.CAE.SelectionRecipe NXOpen.CAE.SelectionRecipeCollection.Copy ( NXOpen.CAE.SelectionRecipe  recipeToCopy,
string  name 
)
inline

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

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

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
recipeToCopy
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
Returns
unsafe NXOpen.CAE.AttributeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateAttributeRecipe ( string  name,
NXOpen.CAE.CaeSetGroupFilterType  entityType,
bool  resolveRelatedFeEntity,
NXOpen.CAE.CaeSetGroupFilterType  relatedFeEntityType 
)
inline

Creates an Attribute based Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
entityTypeThe main enitity type to which the recipe resolves to.
resolveRelatedFeEntityResolve to FE entity type related to main entity type.
relatedFeEntityTypeThe FE enitity type related to the main entity type. Recipe will only resolve to the FE entity type, not the main entity type.
Returns
unsafe NXOpen.CAE.BoundingVolumeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateBoxBoundingVolumeRecipe ( string  name,
NXOpen.CoordinateSystem  centerCsys,
NXOpen.Expression  length,
NXOpen.Expression  width,
NXOpen.Expression  height,
NXOpen.CAE.CaeSetGroupFilterType[]  entityTypes 
)
inline

Create a Bounding Volume Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
centerCsys
length
width
height
entityTypesEntity types to which this recipe resolves to. If a null reference (Nothing in Visual Basic) default will be Nodes
Returns
unsafe NXOpen.CAE.BoundingVolumeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateBoxBoundingVolumeRecipe ( string  name,
NXOpen.Point  centerPoint,
NXOpen.Point  targetPoint,
NXOpen.CAE.CaeSetGroupFilterType[]  entityTypes 
)
inline

Create a Bounding Volume Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
centerPoint
targetPoint
entityTypesEntity types to which this recipe resolves to. If a null reference (Nothing in Visual Basic) default will be Nodes
Returns
unsafe NXOpen.CAE.CloneSelRecipeBuilder NXOpen.CAE.SelectionRecipeCollection.CreateCloneSelRecipeBuilder ( bool  deleteSourceRecipe,
NXOpen.CAE.SelectionRecipe  sourceSelRecipe 
)
inline

Creates a Clone Selection Recipe Builder.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
deleteSourceRecipe
sourceSelRecipe
Returns
unsafe NXOpen.CAE.CoordinateSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateCoordinateRecipe ( string  name,
NXOpen.Point3d  coordinates,
double  tolerance 
)
inline

Creates a Coordinate based Single Node Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
coordinatesThe coordinates to be used in the search.
toleranceThe search tolerance.
Returns
unsafe NXOpen.CAE.BoundingVolumeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateCylinderBoundingVolumeRecipe ( string  name,
NXOpen.CoordinateSystem  centerCsys,
NXOpen.Expression  diameter,
NXOpen.Expression  cylinderHeight,
NXOpen.CAE.CaeSetGroupFilterType[]  entityTypes 
)
inline

Create a Bounding Volume Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
centerCsys
diameter
cylinderHeight
entityTypesEntity types to which this recipe resolves to. If a null reference (Nothing in Visual Basic) default will be Nodes
Returns
unsafe NXOpen.CAE.BoundingVolumeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateCylinderBoundingVolumeRecipe ( string  name,
NXOpen.Expression  diameter,
NXOpen.Point  baseCenter,
NXOpen.Point  topCenter,
NXOpen.CAE.CaeSetGroupFilterType[]  entityTypes 
)
inline

Create a Bounding Volume Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
diameter
baseCenter
topCenter
entityTypesEntity types to which this recipe resolves to. If a null reference (Nothing in Visual Basic) default will be Nodes
Returns
unsafe NXOpen.CAE.LabelRangeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateLabelRangeRecipe ( string  name,
int[]  singleLabels,
int[]  startLabels,
int[]  endLabels,
int[]  increments,
NXOpen.CAE.CaeSetGroupFilterType  entityType 
)
inline

Creates a Label Range Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
singleLabels
startLabels
endLabels
increments
entityType
Returns
unsafe NXOpen.CAE.PointSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreatePointRecipe ( string  name,
NXOpen.Point  point,
double  tolerance 
)
inline

Creates a Point based Single Node Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
pointThe point whom coordinates will be used in the search.
toleranceThe search tolerance.
Returns
unsafe NXOpen.CAE.SelRecipeBuilder NXOpen.CAE.SelectionRecipeCollection.CreateSelRecipeBuilder ( )
inline

Creates a builder for Selection Recipe

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe NXOpen.CAE.SingleLabelSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateSingleLabelRecipe ( string  name,
int  nodeLabel 
)
inline

Creates a Single Node Label Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
nodeLabelThe label of the node to which the recipe resolves to.
Returns
unsafe NXOpen.CAE.BoundingVolumeSelectionRecipe NXOpen.CAE.SelectionRecipeCollection.CreateSphereBoundingVolumeRecipe ( string  name,
NXOpen.Point  centerPoint,
NXOpen.Expression  diameter,
NXOpen.CAE.CaeSetGroupFilterType[]  entityTypes 
)
inline

Create a Bounding Volume Selection Recipe

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.SelRecipeBuilder instead.

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

Parameters
nameName of the selection recipe. If a null reference (Nothing in Visual Basic), then a valid unique name will be generated.
centerPoint
diameter
entityTypesEntity types to which this recipe resolves to. If a null reference (Nothing in Visual Basic) default will be Nodes
Returns
unsafe void NXOpen.CAE.SelectionRecipeCollection.Delete ( NXOpen.CAE.SelectionRecipe[]  recipes)
inline

Delete a list of selection recipes

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
recipesThe recipes to be deleted
override int NXOpen.CAE.SelectionRecipeCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.CAE.SelectionRecipe NXOpen.CAE.SelectionRecipeCollection.FindObject ( string  journalIdentifier)
inline

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.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
journalIdentifierIdentifier of the Set you want
Returns
NXOpen.CAE.SelectionRecipe [] NXOpen.CAE.SelectionRecipeCollection.ToArray ( )
inline

Returns an array of NXOpen.CAE.SelectionRecipe objects.

Property Documentation

Tag NXOpen.CAE.SelectionRecipeCollection.Tag
get

Returns the tag of this object.


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