NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::ReplaceFeatureBuilder Class Reference

Represents a replace feature builder. More...

Inheritance diagram for NXOpen::Features::ReplaceFeatureBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MappingMethodType { MappingMethodTypeMapOnlyObjectsWithModelingDependencies, MappingMethodTypeMapAllObjects }
 Type of mapping method to be used for replace feature. More...
 

Public Member Functions

void AutomatchMap ()
 Match the map automatically
Created in NX6.0.0. More...
 
bool CopyReplacementFeature ()
 Returns the indication on whether to copy the replacement feature. More...
 
bool DeleteOriginalFeature ()
 Returns the indication on whether to delete the original feature or not. More...
 
bool DisplayUniqueInputsToMap ()
 Returns the indication on whether to use the unique mapping of parent objects instead of whole Selection Intent. More...
 
bool DoAutomaticGeomMatch ()
 Returns the indication on whether to perform automatic geometric matching or not. More...
 
NXOpen::Features::FeatureReferencesBuilderFeatureReferences ()
 Returns the feature references builder
Created in NX6.0.0. More...
 
bool IsMappingToleranceIncreased ()
 Returns the Geometric Matching Allowance is increased or decreased from its previous value
Created in NX9.0.0. More...
 
bool KeepFeatureToReplace ()
 Returns the indication on whether to keep the original feature or not. More...
 
NXOpen::Features::ReplaceFeatureBuilder::MappingMethodType MappingMethod ()
 Returns the mapping method
Created in NX6.0.0. More...
 
double MappingTolerance ()
 Returns the distance tolerance to use for mapping
Created in NX6.0.0. More...
 
NXOpen::Features::SelectFeatureListReplacementFeature ()
 Returns the selection list of replacement features
Created in NX6.0.0. More...
 
NXOpen::Features::SelectFeatureListSelectFeature ()
 Returns the selection list of features to be replaced
Created in NX6.0.0. More...
 
void SetCopyReplacementFeature (bool copyReplacementFeature)
 Sets the indication on whether to copy the replacement feature. More...
 
void SetDeleteOriginalFeature (bool deleteOriginalFeature)
 Sets the indication on whether to delete the original feature or not. More...
 
void SetDisplayUniqueInputsToMap (bool displayUniqueInputsToMap)
 Sets the indication on whether to use the unique mapping of parent objects instead of whole Selection Intent. More...
 
void SetDoAutomaticGeomMatch (bool doAutomaticGeomMatch)
 Sets the indication on whether to perform automatic geometric matching or not. More...
 
void SetKeepFeatureToReplace (bool keepFeatureToReplace)
 Sets the indication on whether to keep the original feature or not. More...
 
void SetMappingMethod (NXOpen::Features::ReplaceFeatureBuilder::MappingMethodType mappingMethod)
 Sets the mapping method
Created in NX6.0.0. More...
 
void SetMappingTolerance (double mappingTolerance)
 Sets the distance tolerance to use for mapping
Created in NX6.0.0. More...
 
void SetMappingToleranceIncreased (bool isMappingToleranceIncreased)
 Sets the Geometric Matching Allowance is increased or decreased from its previous value
Created in NX9.0.0. More...
 
void SetMatchingForIndex (int indices, NXOpen::NXObject *matchingTag)
 Set the matching reference using the index into the feature references
Created in NX6.0.0. More...
 
void SetMatchingForParent (NXOpen::NXObject *parentTag, NXOpen::NXObject *matchingTag)
 Set the matching reference using the parent to match in the feature references
Created in NX6.0.0. More...
 
void UpdateMap ()
 Populate the feature references according to the replaced feature
Created in NX6.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

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


Created in NX6.0.0.

Member Enumeration Documentation

Type of mapping method to be used for replace feature.

Enumerator
MappingMethodTypeMapOnlyObjectsWithModelingDependencies 

map only objects with modeling dependencies

MappingMethodTypeMapAllObjects 

Not supported yet.

Member Function Documentation

void NXOpen::Features::ReplaceFeatureBuilder::AutomatchMap ( )

Match the map automatically
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

bool NXOpen::Features::ReplaceFeatureBuilder::CopyReplacementFeature ( )

Returns the indication on whether to copy the replacement feature.

True indicates that the replacement feature should be copied before replacing the specified feature.
Created in NX6.0.0.

License requirements : None

bool NXOpen::Features::ReplaceFeatureBuilder::DeleteOriginalFeature ( )

Returns the indication on whether to delete the original feature or not.

True indicates the feature should be deleted.
Created in NX7.5.2.

License requirements : None

bool NXOpen::Features::ReplaceFeatureBuilder::DisplayUniqueInputsToMap ( )

Returns the indication on whether to use the unique mapping of parent objects instead of whole Selection Intent.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::ReplaceFeatureBuilder::DoAutomaticGeomMatch ( )

Returns the indication on whether to perform automatic geometric matching or not.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::FeatureReferencesBuilder* NXOpen::Features::ReplaceFeatureBuilder::FeatureReferences ( )

Returns the feature references builder
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::ReplaceFeatureBuilder::IsMappingToleranceIncreased ( )

Returns the Geometric Matching Allowance is increased or decreased from its previous value
Created in NX9.0.0.



License requirements : None

bool NXOpen::Features::ReplaceFeatureBuilder::KeepFeatureToReplace ( )

Returns the indication on whether to keep the original feature or not.

True indicates the feature should be kept.

Deprecated:
Deprecated in NX7.5.2. Use Features::ReplaceFeatureBuilder::DeleteOriginalFeature instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Features::ReplaceFeatureBuilder::MappingMethodType NXOpen::Features::ReplaceFeatureBuilder::MappingMethod ( )

Returns the mapping method
Created in NX6.0.0.



License requirements : None

double NXOpen::Features::ReplaceFeatureBuilder::MappingTolerance ( )

Returns the distance tolerance to use for mapping
Created in NX6.0.0.



License requirements : None

NXOpen::Features::SelectFeatureList* NXOpen::Features::ReplaceFeatureBuilder::ReplacementFeature ( )

Returns the selection list of replacement features
Created in NX6.0.0.



License requirements : None

NXOpen::Features::SelectFeatureList* NXOpen::Features::ReplaceFeatureBuilder::SelectFeature ( )

Returns the selection list of features to be replaced
Created in NX6.0.0.



License requirements : None

void NXOpen::Features::ReplaceFeatureBuilder::SetCopyReplacementFeature ( bool  copyReplacementFeature)

Sets the indication on whether to copy the replacement feature.

True indicates that the replacement feature should be copied before replacing the specified feature.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
copyReplacementFeaturecopyreplacementfeature
void NXOpen::Features::ReplaceFeatureBuilder::SetDeleteOriginalFeature ( bool  deleteOriginalFeature)

Sets the indication on whether to delete the original feature or not.

True indicates the feature should be deleted.
Created in NX7.5.2.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
deleteOriginalFeaturedeleteoriginalfeature
void NXOpen::Features::ReplaceFeatureBuilder::SetDisplayUniqueInputsToMap ( bool  displayUniqueInputsToMap)

Sets the indication on whether to use the unique mapping of parent objects instead of whole Selection Intent.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
displayUniqueInputsToMapdisplayuniqueinputstomap
void NXOpen::Features::ReplaceFeatureBuilder::SetDoAutomaticGeomMatch ( bool  doAutomaticGeomMatch)

Sets the indication on whether to perform automatic geometric matching or not.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
doAutomaticGeomMatchdoautomaticgeommatch
void NXOpen::Features::ReplaceFeatureBuilder::SetKeepFeatureToReplace ( bool  keepFeatureToReplace)

Sets the indication on whether to keep the original feature or not.

True indicates the feature should be kept.

Deprecated:
Deprecated in NX7.5.2. Use Features::ReplaceFeatureBuilder::SetDeleteOriginalFeature instead.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
keepFeatureToReplacekeepfeaturetoreplace
void NXOpen::Features::ReplaceFeatureBuilder::SetMappingMethod ( NXOpen::Features::ReplaceFeatureBuilder::MappingMethodType  mappingMethod)

Sets the mapping method
Created in NX6.0.0.



License requirements : None

Parameters
mappingMethodmappingmethod
void NXOpen::Features::ReplaceFeatureBuilder::SetMappingTolerance ( double  mappingTolerance)

Sets the distance tolerance to use for mapping
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
mappingTolerancemappingtolerance
void NXOpen::Features::ReplaceFeatureBuilder::SetMappingToleranceIncreased ( bool  isMappingToleranceIncreased)

Sets the Geometric Matching Allowance is increased or decreased from its previous value
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
isMappingToleranceIncreasedismappingtoleranceincreased
void NXOpen::Features::ReplaceFeatureBuilder::SetMatchingForIndex ( int  indices,
NXOpen::NXObject matchingTag 
)

Set the matching reference using the index into the feature references
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
indicesIndex to use in the feature references builder
matchingTagMatching value
void NXOpen::Features::ReplaceFeatureBuilder::SetMatchingForParent ( NXOpen::NXObject parentTag,
NXOpen::NXObject matchingTag 
)

Set the matching reference using the parent to match in the feature references
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
parentTagParent to match in the feature references builder
matchingTagMatching value
void NXOpen::Features::ReplaceFeatureBuilder::UpdateMap ( )

Populate the feature references according to the replaced feature
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")


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