NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Positioning.MatingConverter Class Reference

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

Inheritance diagram for NXOpen.Positioning.MatingConverter:

Public Types

enum  PartContext { InOwningPart, InLoadedChildren, InAllChildren }
 Defines in which parts mating conditions will be converted. More...
 

Public Member Functions

unsafe void ConvertMatingConditions ()
 Converts Mating Conditions to Assembly Constraints according to the properties defined on this NXOpen.Positioning.MatingConverter object. More...
 
unsafe
NXOpen.Positioning.Constraint[] 
GetConvertedConstraints ()
 Returns all constraints converted by this conversion operation. More...
 
unsafe
NXOpen.Positioning.Constraint[] 
GetConvertedParts ()
 Returns all parts converted by this conversion operation. More...
 
unsafe string[] GetLatestResults (bool showAllResults)
 Returns textual descriptions of the results of the last conversion operation More...
 
unsafe string[] GetResults (bool showAllResults)
 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 . More...
 
unsafe void DeleteResults ()
 Removes details from the mating conversion results of the individual constraints that were converted. More...
 
unsafe void Destroy ()
 Deletes this NXOpen.Positioning.MatingConverter immediately. More...
 

Properties

unsafe
NXOpen.Positioning.MatingConverter.PartContext 
Context [get, set]
 Returns or sets the current conversion context in which mating conditions will be converted. More...
 
unsafe bool LoadReferencedGeometry [get, set]
 Returns or sets whether to load unloaded referenced geometry before performing a conversion. More...
 
unsafe NXOpen.PartLoadStatus LoadStatus [get]
 Returns the load status resulting from a conversion operation. More...
 
unsafe int NumberOfConvertedParts [get]
 Returns the number of parts parts converted by this conversion operation. More...
 

Detailed Description

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 using NXOpen.Assemblies.ComponentAssembly.CreateMatingConverter .

Not directly created by user.

Created in NX5.0.0

Member Enumeration Documentation

Defines in which parts mating conditions will be converted.

Enumerator
InOwningPart 

Convert mating conditions in the owning part

InLoadedChildren 

Convert mating conditions in the owning part and all loaded children.

Partially-loaded children will be fully-loaded.

InAllChildren 

Convert mating conditions in the owning part and all children.

Partially-loaded and unloaded children will be fully-loaded.

Member Function Documentation

unsafe void NXOpen.Positioning.MatingConverter.ConvertMatingConditions ( )

Converts Mating Conditions to Assembly Constraints according to the properties defined on this NXOpen.Positioning.MatingConverter object.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.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.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Positioning.MatingConverter.Destroy ( )

Deletes this NXOpen.Positioning.MatingConverter immediately.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Positioning.Constraint [] NXOpen.Positioning.MatingConverter.GetConvertedConstraints ( )

Returns all constraints converted by this conversion operation.

Use NXOpen.Positioning.Constraint.GenerateConversionReport to obtain the conversion status of these constraints.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns
The converted constraints
unsafe NXOpen.Positioning.Constraint [] NXOpen.Positioning.MatingConverter.GetConvertedParts ( )

Returns all parts converted by this conversion operation.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns
The converted constraints
unsafe string [] NXOpen.Positioning.MatingConverter.GetLatestResults ( bool  showAllResults)

Returns textual descriptions of the results of the last conversion operation

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
showAllResultsWhether to show results for all converted constraints even if no issues arose during their conversion
Returns
The generated results
unsafe string [] NXOpen.Positioning.MatingConverter.GetResults ( bool  showAllResults)

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 .

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
showAllResultsWhether to show results for all converted constraints even if no issues arose during their conversion
Returns
The generated results

Property Documentation

unsafe NXOpen.Positioning.MatingConverter.PartContext NXOpen.Positioning.MatingConverter.Context
getset

Returns or sets the current conversion context in which mating conditions will be converted.

Created in NX5.0.0

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.Positioning.MatingConverter.LoadReferencedGeometry
getset

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.

Created in NX5.0.0

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.PartLoadStatus NXOpen.Positioning.MatingConverter.LoadStatus
get

Returns the load status resulting from a conversion operation.

This indicates any problems which arose when loading parts during conversion.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe int NXOpen.Positioning.MatingConverter.NumberOfConvertedParts
get

Returns the number of parts parts converted by this conversion operation.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")


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