NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::GeometricUtilities::ReplAsstBuilder Class Reference

Represents a NXOpen::GeometricUtilities::ReplAsstBuilder . More...

Inheritance diagram for NXOpen::GeometricUtilities::ReplAsstBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

double Allowance ()
 Returns the deviation allowance for geometric matching
Created in NX6.0.0. More...
 
NXOpen::GeometricUtilities::ParentEquivalencyMapCreateEmptyMatch ()
 This is the default creator for a parent equivalency map. More...
 
void CreateGeometricMaps (std::vector< NXOpen::GeometricUtilities::ParentEquivalencyMap * > &maps)
 Perform geometric matching. More...
 
void CreateInferredMaps (std::vector< NXOpen::GeometricUtilities::ParentEquivalencyMap * > &maps)
 Infer more matches from matches already 'Accepted'. More...
 
void CreateNameBasedMaps (std::vector< NXOpen::GeometricUtilities::ParentEquivalencyMap * > &maps)
 Perform automatic matching based on user-defined object names. More...
 
void Enter ()
 Entry and re-entry to the Replacement Assistant mapping environment. More...
 
void Exit ()
 Exit the Replacement Assistant mapping environment. More...
 
NXOpen::GeometricUtilities::ParentEquivalencyMapListMatchList ()
 Returns the list of all Parent Equivalency Map objects
Created in NX6.0.0. More...
 
bool MatchSheetBoundariesOnly ()
 Returns the automatic matching preference to match sheet boundaries only
Created in NX6.0.0. More...
 
bool OneToOne ()
 Returns the one to one auto matching preference
Created in NX6.0.0. More...
 
int QueryFeatureOutputUsage ()
 Query the downstream usage of the current feature's output entities and populate the usageInfoList. More...
 
void SetAllowance (double allowance)
 Sets the deviation allowance for geometric matching
Created in NX6.0.0. More...
 
void SetMatchSheetBoundariesOnly (bool sheetBoundariesOnly)
 Sets the automatic matching preference to match sheet boundaries only
Created in NX6.0.0. More...
 
void SetNewParents (const std::vector< NXOpen::DisplayableObject * > &replacementObjects)
 Set the source entities for the Replacement Assistant. More...
 
void SetOneToOne (bool oneToOne)
 Sets the one to one auto matching preference
Created in NX6.0.0. More...
 
void SetProdInt (NXOpen::TaggedObject *prodInt)
 Set the product interface tag for the Replacement Assistant. More...
 
NXOpen::GeometricUtilities::EntityUsageInfoListUsageInfoList ()
 Returns the list of all Entity Usage Info objects
Created in NX6.0.0. 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 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.


Created in NX6.0.0.

Member Function Documentation

double NXOpen::GeometricUtilities::ReplAsstBuilder::Allowance ( )

Returns the deviation allowance for geometric matching
Created in NX6.0.0.



License requirements : None

NXOpen::GeometricUtilities::ParentEquivalencyMap* NXOpen::GeometricUtilities::ReplAsstBuilder::CreateEmptyMatch ( )

This is the default creator for a parent equivalency map.

Returns

Created in NX6.0.0.

License requirements : None
void NXOpen::GeometricUtilities::ReplAsstBuilder::CreateGeometricMaps ( std::vector< NXOpen::GeometricUtilities::ParentEquivalencyMap * > &  maps)

Perform geometric matching.


Created in NX6.0.0.

License requirements : None

Parameters
mapsnew maps created by geometric matching
void NXOpen::GeometricUtilities::ReplAsstBuilder::CreateInferredMaps ( std::vector< NXOpen::GeometricUtilities::ParentEquivalencyMap * > &  maps)

Infer more matches from matches already 'Accepted'.

Add [array_order_guaranteed] annotation for output array when API wrap allows the same.
Created in NX6.0.0.

License requirements : None

Parameters
mapsnew maps created by inferring
void NXOpen::GeometricUtilities::ReplAsstBuilder::CreateNameBasedMaps ( std::vector< NXOpen::GeometricUtilities::ParentEquivalencyMap * > &  maps)

Perform automatic matching based on user-defined object names.


Created in NX6.0.0.

License requirements : None

Parameters
mapsnew maps created by name-based matching
void NXOpen::GeometricUtilities::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.
Created in NX6.0.0.

License requirements : None

void NXOpen::GeometricUtilities::ReplAsstBuilder::Exit ( )

Exit the Replacement Assistant mapping environment.

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


Created in NX6.0.0.

License requirements : None

NXOpen::GeometricUtilities::ParentEquivalencyMapList* NXOpen::GeometricUtilities::ReplAsstBuilder::MatchList ( )

Returns the list of all Parent Equivalency Map objects
Created in NX6.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::ReplAsstBuilder::MatchSheetBoundariesOnly ( )

Returns the automatic matching preference to match sheet boundaries only
Created in NX6.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::ReplAsstBuilder::OneToOne ( )

Returns the one to one auto matching preference
Created in NX6.0.0.



License requirements : None

int NXOpen::GeometricUtilities::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.

Returns

Created in NX6.0.0.

License requirements : None
void NXOpen::GeometricUtilities::ReplAsstBuilder::SetAllowance ( double  allowance)

Sets the deviation allowance for geometric matching
Created in NX6.0.0.



License requirements : None

Parameters
allowanceallowance
void NXOpen::GeometricUtilities::ReplAsstBuilder::SetMatchSheetBoundariesOnly ( bool  sheetBoundariesOnly)

Sets the automatic matching preference to match sheet boundaries only
Created in NX6.0.0.



License requirements : None

Parameters
sheetBoundariesOnlysheetboundariesonly
void NXOpen::GeometricUtilities::ReplAsstBuilder::SetNewParents ( const std::vector< NXOpen::DisplayableObject * > &  replacementObjects)

Set the source entities for the Replacement Assistant.

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

License requirements : None

Parameters
replacementObjectsreplacement objects
void NXOpen::GeometricUtilities::ReplAsstBuilder::SetOneToOne ( bool  oneToOne)

Sets the one to one auto matching preference
Created in NX6.0.0.



License requirements : None

Parameters
oneToOneonetoone
void NXOpen::GeometricUtilities::ReplAsstBuilder::SetProdInt ( NXOpen::TaggedObject prodInt)

Set the product interface tag for the Replacement Assistant.


Created in NX11.0.1.

License requirements : None

Parameters
prodIntprodint
NXOpen::GeometricUtilities::EntityUsageInfoList* NXOpen::GeometricUtilities::ReplAsstBuilder::UsageInfoList ( )

Returns the list of all Entity Usage Info objects
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::ReplAsstBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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