ReplAsstBuilder Class

class NXOpen.GeometricUtilities.ReplAsstBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.GeometricUtilities.ReplAsstBuilder.

This is the primary data container for Replacement Assistant mapping environment available on editing Linked Body, Linked Face, Extract Body, Extract Face and Mirror Body features. Execute Enter() before invoking any match creation or automatic matching APIs. Call Exit() to exit the mapping environment.

New in version NX6.0.0.

Properties

Property	Description
Allowance	Returns or sets the deviation allowance for geometric matching
MatchList	Returns the list of all Parent Equivalency Map objects
MatchSheetBoundariesOnly	Returns or sets the automatic matching preference to match sheet boundaries only
OneToOne	Returns or sets the one to one auto matching preference
Tag	Returns the Tag for this object.
UsageInfoList	Returns the list of all Entity Usage Info objects

Methods

Method	Description
CreateEmptyMatch	This is the default creator for a parent equivalency map.
CreateGeometricMaps	Perform geometric matching.
CreateInferredMaps	Infer more matches from matches already ‘Accepted’.
CreateNameBasedMaps	Perform automatic matching based on user-defined object names.
Enter	Entry and re-entry to the Replacement Assistant mapping environment.
Exit	Exit the Replacement Assistant mapping environment.
QueryFeatureOutputUsage	Query the downstream usage of the current feature’s output entities and populate the usageInfoList.
SetNewParents	Set the source entities for the Replacement Assistant.
SetProdInt	Set the product interface tag for the Replacement Assistant.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Allowance

ReplAsstBuilder.Allowance

Returns or sets the deviation allowance for geometric matching

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

Getter Method

Signature Allowance

Returns: Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Allowance

Parameters:allowance (float) –

New in version NX6.0.0.

License requirements: None.

MatchList

ReplAsstBuilder.MatchList

Returns the list of all Parent Equivalency Map objects

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

Getter Method

Signature MatchList

Returns: Return type:NXOpen.GeometricUtilities.ParentEquivalencyMapList

New in version NX6.0.0.

License requirements: None.

MatchSheetBoundariesOnly

ReplAsstBuilder.MatchSheetBoundariesOnly

Returns or sets the automatic matching preference to match sheet boundaries only

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

Getter Method

Signature MatchSheetBoundariesOnly

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MatchSheetBoundariesOnly

Parameters:sheetBoundariesOnly (bool) –

New in version NX6.0.0.

License requirements: None.

OneToOne

ReplAsstBuilder.OneToOne

Returns or sets the one to one auto matching preference

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

Getter Method

Signature OneToOne

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature OneToOne

Parameters:oneToOne (bool) –

New in version NX6.0.0.

License requirements: None.

UsageInfoList

ReplAsstBuilder.UsageInfoList

Returns the list of all Entity Usage Info objects

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

Getter Method

Signature UsageInfoList

Returns: Return type:NXOpen.GeometricUtilities.EntityUsageInfoList

New in version NX6.0.0.

License requirements: None.

Method Detail

CreateEmptyMatch

ReplAsstBuilder.CreateEmptyMatch

This is the default creator for a parent equivalency map.

Signature CreateEmptyMatch()

Returns: Return type:NXOpen.GeometricUtilities.ParentEquivalencyMap

New in version NX6.0.0.

License requirements: None.

CreateGeometricMaps

ReplAsstBuilder.CreateGeometricMaps

Perform geometric matching.

Signature CreateGeometricMaps()

Returns:new maps created by geometric matching Return type:list of NXOpen.GeometricUtilities.ParentEquivalencyMap

New in version NX6.0.0.

License requirements: None.

CreateInferredMaps

ReplAsstBuilder.CreateInferredMaps

Infer more matches from matches already ‘Accepted’.

Add [array_order_guaranteed] annotation for output array when API wrap allows the same.

Signature CreateInferredMaps()

Returns:new maps created by inferring Return type:list of NXOpen.GeometricUtilities.ParentEquivalencyMap

New in version NX6.0.0.

License requirements: None.

CreateNameBasedMaps

ReplAsstBuilder.CreateNameBasedMaps

Perform automatic matching based on user-defined object names.

Signature CreateNameBasedMaps()

Returns:new maps created by name-based matching Return type:list of NXOpen.GeometricUtilities.ParentEquivalencyMap

New in version NX6.0.0.

License requirements: None.

Enter

ReplAsstBuilder.Enter

Entry and re-entry to the Replacement Assistant mapping environment.

This function needs to be executed before invoking any match creation or automatic matching APIs. The matches inferred internally (internal identifier reuse, inherited from parent and siblings) will be populated when this function is executed for the first time after selecting a replacement entity.

Signature Enter()

New in version NX6.0.0.

License requirements: None.

Exit

ReplAsstBuilder.Exit

Exit the Replacement Assistant mapping environment.

Any match creation or automatic matchping API cannot be executed after this function is called.

Signature Exit()

New in version NX6.0.0.

License requirements: None.

QueryFeatureOutputUsage

ReplAsstBuilder.QueryFeatureOutputUsage

Query the downstream usage of the current feature’s output entities and populate the usageInfoList.

This API need be called only ONCE per feature being reparented.

Signature QueryFeatureOutputUsage()

Returns: Return type:int

New in version NX6.0.0.

License requirements: None.

SetNewParents

ReplAsstBuilder.SetNewParents

Set the source entities for the Replacement Assistant.

If there are matches already created and the body is changed, the matches will be deleted.

Signature SetNewParents(replacementObjects)

Parameters:replacementObjects (list of NXOpen.DisplayableObject) – replacement objects

New in version NX6.0.0.

License requirements: None.

SetProdInt

ReplAsstBuilder.SetProdInt

Set the product interface tag for the Replacement Assistant.

Signature SetProdInt(prodInt)

Parameters:prodInt (NXOpen.TaggedObject) –

New in version NX11.0.1.

License requirements: None.

Validate

ReplAsstBuilder.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.