MatingConverter Class¶
-
class
NXOpen.Positioning.
MatingConverter
¶ Bases:
NXOpen.TaggedObject
An instance of this class can be used to convert Mating Conditions to Assembly Constraints in its owning assembly or in child parts of its owning assembly.
The owning assembly is the
NXOpen.Assemblies.ComponentAssembly
from which this object was obtained usingNXOpen.Assemblies.ComponentAssembly.CreateMatingConverter()
.Not directly created by user.
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Context | Returns or sets the current conversion context in which mating conditions will be converted. |
LoadReferencedGeometry | Returns or sets whether to load unloaded referenced geometry before performing a conversion. |
LoadStatus | Returns the load status resulting from a conversion operation. |
NumberOfConvertedParts | Returns the number of parts parts converted by this conversion operation. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
ConvertMatingConditions | Converts Mating Conditions to Assembly Constraints according to the properties defined on this NXOpen.Positioning.MatingConverter object. |
DeleteResults | Removes details from the mating conversion results of the individual constraints that were converted. |
Destroy | Deletes this NXOpen.Positioning.MatingConverter immediately. |
GetConvertedConstraints | Returns all constraints converted by this conversion operation. |
GetConvertedParts | Returns all parts converted by this conversion operation. |
GetLatestResults | Returns textual descriptions of the results of the last conversion operation |
GetResults | Returns textual descriptions of the results of all prior conversion operations for all the parts described by the current context set using NXOpen.Positioning.MatingConverter.Context() . |
Enumerations¶
MatingConverterPartContext Enumeration | Defines in which parts mating conditions will be converted. |
Property Detail¶
Context¶
-
MatingConverter.
Context
¶ Returns or sets the current conversion context in which mating conditions will be converted.
-------------------------------------
Getter Method
Signature
Context
Returns: The current context Return type: NXOpen.Positioning.MatingConverterPartContext
New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
-------------------------------------
Setter Method
Signature
Context
Parameters: context ( NXOpen.Positioning.MatingConverterPartContext
) – The new contextNew in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
LoadReferencedGeometry¶
-
MatingConverter.
LoadReferencedGeometry
¶ Returns or sets whether to load unloaded referenced geometry before performing a conversion.
When all referenced geometry is loaded the conversion operation is more effective. If it isn’t loaded, then the conversion operation will often need to be completed next time the assembly and geometry are loaded together.
-------------------------------------
Getter Method
Signature
LoadReferencedGeometry
Returns: Whether referenced-geometry will be loaded Return type: bool New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
-------------------------------------
Setter Method
Signature
LoadReferencedGeometry
Parameters: loadGeometry (bool) – Whether to load referenced-geometry New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
LoadStatus¶
-
MatingConverter.
LoadStatus
¶ Returns the load status resulting from a conversion operation.
This indicates any problems which arose when loading parts during conversion.
-------------------------------------
Getter Method
Signature
LoadStatus
Returns: Parts that could not be loaded and their associated errors. :rtype:
NXOpen.PartLoadStatus
New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
NumberOfConvertedParts¶
-
MatingConverter.
NumberOfConvertedParts
¶ Returns the number of parts parts converted by this conversion operation.
-------------------------------------
Getter Method
Signature
NumberOfConvertedParts
Returns: The number of converted parts Return type: int New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
Method Detail¶
ConvertMatingConditions¶
-
MatingConverter.
ConvertMatingConditions
¶ Converts Mating Conditions to Assembly Constraints according to the properties defined on this
NXOpen.Positioning.MatingConverter
object.Signature
ConvertMatingConditions()
New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
DeleteResults¶
-
MatingConverter.
DeleteResults
¶ Removes details from the mating conversion results of the individual constraints that were converted.
This will be applied to the mating conversion results in the parts described by the current context (determined by
NXOpen.Positioning.MatingConverter.Context()
). Note that the summary information for each part in the conversion results is not modified by this function.Signature
DeleteResults()
New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
Destroy¶
-
MatingConverter.
Destroy
¶ Deletes this
NXOpen.Positioning.MatingConverter
immediately.Signature
Destroy()
New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetConvertedConstraints¶
-
MatingConverter.
GetConvertedConstraints
¶ Returns all constraints converted by this conversion operation.
Use
NXOpen.Positioning.Constraint.GenerateConversionReport()
to obtain the conversion status of these constraints.Signature
GetConvertedConstraints()
Returns: The converted constraints Return type: list of NXOpen.Positioning.Constraint
New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetConvertedParts¶
-
MatingConverter.
GetConvertedParts
¶ Returns all parts converted by this conversion operation.
Signature
GetConvertedParts()
Returns: The converted constraints Return type: list of NXOpen.Positioning.Constraint
New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetLatestResults¶
-
MatingConverter.
GetLatestResults
¶ Returns textual descriptions of the results of the last conversion operation
Signature
GetLatestResults(showAllResults)
Parameters: showAllResults (bool) – Whether to show results for all converted constraints even if no issues arose during their conversion Returns: The generated results Return type: list of str New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetResults¶
-
MatingConverter.
GetResults
¶ Returns textual descriptions of the results of all prior conversion operations for all the parts described by the current context set using
NXOpen.Positioning.MatingConverter.Context()
.Signature
GetResults(showAllResults)
Parameters: showAllResults (bool) – Whether to show results for all converted constraints even if no issues arose during their conversion Returns: The generated results Return type: list of str New in version NX5.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)