NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::CAE::SelRecipeBuilder Class Reference

Selection Recipe Builder
To create a new instance of this class, use NXOpen::CAE::SelectionRecipeCollection::CreateSelRecipeBuilder

Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::CAE::SelRecipeBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  InputFilterType { InputFilterTypeEntireModel, InputFilterTypeMesh, InputFilterTypeBody, InputFilterTypeComponent }
 the input filter type More...
 

Public Member Functions

NXOpen::CAE::SelRecipeAdapterAddAdapter (NXOpen::SelectionMethod *selectionMethod)
 Add an Adapter Strategy. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddArbitraryVolMeshStrategy (NXOpen::CAE::Mesh *mesh, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add an Arbitary Bounding Volume Strategy. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddArbitraryVolPolygonBodyStrategy (NXOpen::CAE::CAEBody *body, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add an Arbitary Bounding Volume Strategy. More...
 
NXOpen::CAE::SelRecipeAttributeStrategyAddAttributeStrategy (NXOpen::CAE::CaeSetGroupFilterType entityType, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add an Attribute Strategy
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddBoxBoundingVolumeStrategy (NXOpen::Point *centerPoint, NXOpen::Point *targetPoint, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Box Bounding Volume Strategy. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddBoxBoundingVolumeStrategy (NXOpen::CoordinateSystem *centerCsys, NXOpen::Expression *length, NXOpen::Expression *width, NXOpen::Expression *height, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Box Bounding Volume Strategy. More...
 
NXOpen::CAE::SelRecipeCoordinateStrategyAddCoordinateStrategy (const NXOpen::Point3d &coordinates, double tolerance, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Coordinate based Single Node Strategy
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddCylinderBoundingVolumeStrategy (NXOpen::CoordinateSystem *centerCsys, NXOpen::Expression *diameter, NXOpen::Expression *cylinderHeight, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Cylinder Bounding Volume Strategy. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddCylinderBoundingVolumeStrategy (NXOpen::Expression *diameter, NXOpen::Point *baseCenter, NXOpen::Point *topCenter, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Cylinder Bounding Volume Strategy. More...
 
NXOpen::CAE::SelRecipeLabelRangeStrategyAddLabelRangeStrategy (const std::vector< int > &singleLabels, const std::vector< int > &startLabels, const std::vector< int > &endLabels, const std::vector< int > &increments, NXOpen::CAE::CaeSetGroupFilterType entityType, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Label Range Strategy
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipePointStrategyAddPointStrategy (NXOpen::Point *point, double tolerance, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Point based Single Node Strategy
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipeProximityStrategyAddProximityStrategy (const std::vector< NXOpen::TaggedObject * > &selectedObject, double tolerance, NXOpen::CAE::CaeSetGroupFilterType entityType, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Proximity Strategy
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipeSingleLabelStrategyAddSingleLabelStrategy (int nodeLabel, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Single Label Node Strategy
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipeBoundingVolumeStrategyAddSphereBoundingVolumeStrategy (NXOpen::Point *centerPoint, NXOpen::Expression *diameter, const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &entityTypes, NXOpen::CAE::SelRecipeBuilder::InputFilterType inputFilterType, NXOpen::TaggedObject *inputFilter)
 Add a Sphere Bounding Volume Strategy. More...
 
void DeleteLastNStrategies (int nStrategies)
 Delete Last N Strategies
Created in NX1847.0.0. More...
 
NXOpen::CAE::SelRecipeBaseStrategyGetNthStrategy (int index)
 Returns the Nth Strategy. More...
 
NXString RecipeName ()
 Returns the selection recipe name
Created in NX1847.0.0. More...
 
void SetRecipeName (const NXString &recipeName)
 Sets the selection recipe name
Created in NX1847.0.0. More...
 
void SetRecipeName (const char *recipeName)
 Sets the selection recipe name
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Selection Recipe Builder
To create a new instance of this class, use NXOpen::CAE::SelectionRecipeCollection::CreateSelRecipeBuilder

Created in NX1847.0.0.


Member Enumeration Documentation

the input filter type

Enumerator
InputFilterTypeEntireModel 

entire model

InputFilterTypeMesh 

mesh

InputFilterTypeBody 

body

InputFilterTypeComponent 

component

Member Function Documentation

NXOpen::CAE::SelRecipeAdapter* NXOpen::CAE::SelRecipeBuilder::AddAdapter ( NXOpen::SelectionMethod selectionMethod)

Add an Adapter Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
selectionMethodSmart Selector Method which defines the adaptor
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddArbitraryVolMeshStrategy ( NXOpen::CAE::Mesh mesh,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add an Arbitary Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
meshmesh
entityTypesEntity types to which this recipe resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddArbitraryVolPolygonBodyStrategy ( NXOpen::CAE::CAEBody body,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add an Arbitary Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
bodybody
entityTypesEntity types to which this recipe resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeAttributeStrategy* NXOpen::CAE::SelRecipeBuilder::AddAttributeStrategy ( NXOpen::CAE::CaeSetGroupFilterType  entityType,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add an Attribute Strategy
Created in NX1847.0.0.



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

Parameters
entityTypeThe enitity type to which the recipe resolves to.
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddBoxBoundingVolumeStrategy ( NXOpen::Point centerPoint,
NXOpen::Point targetPoint,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Box Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
centerPointcenterpoint
targetPointtargetpoint
entityTypesEntity types to which this strategy resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddBoxBoundingVolumeStrategy ( NXOpen::CoordinateSystem centerCsys,
NXOpen::Expression length,
NXOpen::Expression width,
NXOpen::Expression height,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Box Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
centerCsyscentercsys
lengthlength
widthwidth
heightheight
entityTypesEntity types to which this strategy resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeCoordinateStrategy* NXOpen::CAE::SelRecipeBuilder::AddCoordinateStrategy ( const NXOpen::Point3d coordinates,
double  tolerance,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Coordinate based Single Node Strategy
Created in NX1847.0.0.



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

Parameters
coordinatesThe coordinates to be used in the search.
toleranceThe search tolerance.
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddCylinderBoundingVolumeStrategy ( NXOpen::CoordinateSystem centerCsys,
NXOpen::Expression diameter,
NXOpen::Expression cylinderHeight,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Cylinder Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
centerCsyscentercsys
diameterdiameter
cylinderHeightcylinderheight
entityTypesEntity types to which this strategy resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddCylinderBoundingVolumeStrategy ( NXOpen::Expression diameter,
NXOpen::Point baseCenter,
NXOpen::Point topCenter,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Cylinder Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
diameterdiameter
baseCenterbasecenter
topCentertopcenter
entityTypesEntity types to which this strategy resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeLabelRangeStrategy* NXOpen::CAE::SelRecipeBuilder::AddLabelRangeStrategy ( const std::vector< int > &  singleLabels,
const std::vector< int > &  startLabels,
const std::vector< int > &  endLabels,
const std::vector< int > &  increments,
NXOpen::CAE::CaeSetGroupFilterType  entityType,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Label Range Strategy
Created in NX1847.0.0.



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

Parameters
singleLabelssinglelabels
startLabelsstartlabels
endLabelsendlabels
incrementsincrements
entityTypeentitytype
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipePointStrategy* NXOpen::CAE::SelRecipeBuilder::AddPointStrategy ( NXOpen::Point point,
double  tolerance,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Point based Single Node Strategy
Created in NX1847.0.0.



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

Parameters
pointThe point whom coordinates will be used in the search.
toleranceThe search tolerance.
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeProximityStrategy* NXOpen::CAE::SelRecipeBuilder::AddProximityStrategy ( const std::vector< NXOpen::TaggedObject * > &  selectedObject,
double  tolerance,
NXOpen::CAE::CaeSetGroupFilterType  entityType,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Proximity Strategy
Created in NX1847.0.0.



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

Parameters
selectedObjectselectedobject
toleranceThe search tolerance.
entityTypeThe enitity type to which the recipe resolves to.
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeSingleLabelStrategy* NXOpen::CAE::SelRecipeBuilder::AddSingleLabelStrategy ( int  nodeLabel,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Single Label Node Strategy
Created in NX1847.0.0.



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

Parameters
nodeLabelnodelabel
inputFilterTypeinput filter type
inputFilterinput filter
NXOpen::CAE::SelRecipeBoundingVolumeStrategy* NXOpen::CAE::SelRecipeBuilder::AddSphereBoundingVolumeStrategy ( NXOpen::Point centerPoint,
NXOpen::Expression diameter,
const std::vector< NXOpen::CAE::CaeSetGroupFilterType > &  entityTypes,
NXOpen::CAE::SelRecipeBuilder::InputFilterType  inputFilterType,
NXOpen::TaggedObject inputFilter 
)

Add a Sphere Bounding Volume Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
centerPointcenterpoint
diameterdiameter
entityTypesEntity types to which this strategy resolves to. If NULL default will be Nodes
inputFilterTypeinput filter type
inputFilterinput filter
void NXOpen::CAE::SelRecipeBuilder::DeleteLastNStrategies ( int  nStrategies)

Delete Last N Strategies
Created in NX1847.0.0.



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

Parameters
nStrategiesnstrategies
NXOpen::CAE::SelRecipeBaseStrategy* NXOpen::CAE::SelRecipeBuilder::GetNthStrategy ( int  index)

Returns the Nth Strategy.

Returns

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
indexindex
NXString NXOpen::CAE::SelRecipeBuilder::RecipeName ( )

Returns the selection recipe name
Created in NX1847.0.0.



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

void NXOpen::CAE::SelRecipeBuilder::SetRecipeName ( const NXString recipeName)

Sets the selection recipe name
Created in NX1847.0.0.



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

Parameters
recipeNameName of the selection recipe. If NULL, then a valid unique name will be generated.
void NXOpen::CAE::SelRecipeBuilder::SetRecipeName ( const char *  recipeName)

Sets the selection recipe name
Created in NX1847.0.0.



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

Parameters
recipeNameName of the selection recipe. If NULL, then a valid unique name will be generated.

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