ReplaceFeatureBuilder Class¶
-
class
NXOpen.Features.
ReplaceFeatureBuilder
¶ Bases:
NXOpen.Builder
Represents a replace feature builder.
The replace features does not create a feature, but assists the user through the process of replacing a feature with a new one. To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateReplaceFeatureBuilder()
Default values.
Property Value CopyReplacementFeature 0 DeleteOriginalFeature 0 MappingMethod MapOnlyObjectsWithModelingDependencies New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
CopyReplacementFeature | Returns or sets the indication on whether to copy the replacement feature. |
DeleteOriginalFeature | Returns or sets the indication on whether to delete the original feature or not. |
DisplayUniqueInputsToMap | Returns or sets the indication on whether to use the unique mapping of parent objects instead of whole Selection Intent. |
DoAutomaticGeomMatch | Returns or sets the indication on whether to perform automatic geometric matching or not. |
FeatureReferences | Returns the feature references builder |
IsMappingToleranceIncreased | Returns or sets the Geometric Matching Allowance is increased or decreased from its previous value |
KeepFeatureToReplace | Returns or sets the indication on whether to keep the original feature or not. |
MappingMethod | Returns or sets the mapping method |
MappingTolerance | Returns or sets the distance tolerance to use for mapping |
ReplacementFeature | Returns the selection list of replacement features |
SelectFeature | Returns the selection list of features to be replaced |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AutomatchMap | Match the map automatically |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
SetMatchingForIndex | Set the matching reference using the index into the feature references |
SetMatchingForParent | Set the matching reference using the parent to match in the feature references |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateMap | Populate the feature references according to the replaced feature |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ReplaceFeatureBuilderMappingMethodType Enumeration | Type of mapping method to be used for replace feature |
Property Detail¶
CopyReplacementFeature¶
-
ReplaceFeatureBuilder.
CopyReplacementFeature
¶ Returns or sets the indication on whether to copy the replacement feature.
True indicates that the replacement feature should be copied before replacing the specified feature.
-------------------------------------
Getter Method
Signature
CopyReplacementFeature
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CopyReplacementFeature
Parameters: copyReplacementFeature (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DeleteOriginalFeature¶
-
ReplaceFeatureBuilder.
DeleteOriginalFeature
¶ Returns or sets the indication on whether to delete the original feature or not.
True indicates the feature should be deleted.
-------------------------------------
Getter Method
Signature
DeleteOriginalFeature
Returns: Return type: bool New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
DeleteOriginalFeature
Parameters: deleteOriginalFeature (bool) – New in version NX7.5.2.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayUniqueInputsToMap¶
-
ReplaceFeatureBuilder.
DisplayUniqueInputsToMap
¶ Returns or sets the indication on whether to use the unique mapping of parent objects instead of whole Selection Intent.
-------------------------------------
Getter Method
Signature
DisplayUniqueInputsToMap
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayUniqueInputsToMap
Parameters: displayUniqueInputsToMap (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DoAutomaticGeomMatch¶
-
ReplaceFeatureBuilder.
DoAutomaticGeomMatch
¶ Returns or sets the indication on whether to perform automatic geometric matching or not.
-------------------------------------
Getter Method
Signature
DoAutomaticGeomMatch
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoAutomaticGeomMatch
Parameters: doAutomaticGeomMatch (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
FeatureReferences¶
-
ReplaceFeatureBuilder.
FeatureReferences
¶ Returns the feature references builder
-------------------------------------
Getter Method
Signature
FeatureReferences
Returns: Return type: NXOpen.Features.FeatureReferencesBuilder
New in version NX6.0.0.
License requirements: None.
IsMappingToleranceIncreased¶
-
ReplaceFeatureBuilder.
IsMappingToleranceIncreased
¶ Returns or sets the Geometric Matching Allowance is increased or decreased from its previous value
-------------------------------------
Getter Method
Signature
IsMappingToleranceIncreased
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsMappingToleranceIncreased
Parameters: isMappingToleranceIncreased (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
KeepFeatureToReplace¶
-
ReplaceFeatureBuilder.
KeepFeatureToReplace
¶ Returns or sets the indication on whether to keep the original feature or not.
True indicates the feature should be kept.
-------------------------------------
Getter Method
Signature
KeepFeatureToReplace
Returns: Return type: bool New in version NX6.0.0.
Deprecated since version NX7.5.2: Use
Features.ReplaceFeatureBuilder.DeleteOriginalFeature()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
KeepFeatureToReplace
Parameters: keepFeatureToReplace (bool) – New in version NX6.0.0.
Deprecated since version NX7.5.2: Use
Features.ReplaceFeatureBuilder.DeleteOriginalFeature()
instead.License requirements: solid_modeling (“SOLIDS MODELING”)
MappingMethod¶
-
ReplaceFeatureBuilder.
MappingMethod
¶ Returns or sets the mapping method
-------------------------------------
Getter Method
Signature
MappingMethod
Returns: Return type: NXOpen.Features.ReplaceFeatureBuilderMappingMethodType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MappingMethod
Parameters: mappingMethod ( NXOpen.Features.ReplaceFeatureBuilderMappingMethodType
) –New in version NX6.0.0.
License requirements: None.
MappingTolerance¶
-
ReplaceFeatureBuilder.
MappingTolerance
¶ Returns or sets the distance tolerance to use for mapping
-------------------------------------
Getter Method
Signature
MappingTolerance
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MappingTolerance
Parameters: mappingTolerance (float) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ReplacementFeature¶
-
ReplaceFeatureBuilder.
ReplacementFeature
¶ Returns the selection list of replacement features
-------------------------------------
Getter Method
Signature
ReplacementFeature
Returns: Return type: NXOpen.Features.SelectFeatureList
New in version NX6.0.0.
License requirements: None.
SelectFeature¶
-
ReplaceFeatureBuilder.
SelectFeature
¶ Returns the selection list of features to be replaced
-------------------------------------
Getter Method
Signature
SelectFeature
Returns: Return type: NXOpen.Features.SelectFeatureList
New in version NX6.0.0.
License requirements: None.
Method Detail¶
AutomatchMap¶
-
ReplaceFeatureBuilder.
AutomatchMap
¶ Match the map automatically
Signature
AutomatchMap()
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetMatchingForIndex¶
-
ReplaceFeatureBuilder.
SetMatchingForIndex
¶ Set the matching reference using the index into the feature references
Signature
SetMatchingForIndex(indices, matchingTag)
Parameters: - indices (int) – Index to use in the feature references builder
- matchingTag (
NXOpen.NXObject
) – Matching value
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetMatchingForParent¶
-
ReplaceFeatureBuilder.
SetMatchingForParent
¶ Set the matching reference using the parent to match in the feature references
Signature
SetMatchingForParent(parentTag, matchingTag)
Parameters: - parentTag (
NXOpen.NXObject
) – Parent to match in the feature references builder - matchingTag (
NXOpen.NXObject
) – Matching value
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
- parentTag (
UpdateMap¶
-
ReplaceFeatureBuilder.
UpdateMap
¶ Populate the feature references according to the replaced feature
Signature
UpdateMap()
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
ReplaceFeatureBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.