NX Open C++ Reference Guide
Public Types | Public Member Functions
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:
NXOpen::TaggedObject

List of all members.

Public Types

enum  PartContext { PartContextInOwningPart, PartContextInLoadedChildren, PartContextInAllChildren }
 Defines in which parts mating conditions will be converted. More...

Public Member Functions

NXOpen::Positioning::MatingConverter::PartContext Context ()
 Returns the current conversion context in which mating conditions will be converted.
void ConvertMatingConditions ()
 Converts Mating Conditions to Assembly Constraints according to the properties defined on this Positioning::MatingConverter object.
void DeleteResults ()
 Removes details from the mating conversion results of the individual constraints that were converted.
void Destroy ()
 Deletes this Positioning::MatingConverter immediately.
std::vector
< NXOpen::Positioning::Constraint * > 
GetConvertedConstraints ()
 Returns all constraints converted by this conversion operation.
std::vector
< NXOpen::Positioning::Constraint * > 
GetConvertedParts ()
 Returns all parts converted by this conversion operation.
std::vector< NXStringGetLatestResults (bool showAllResults)
 Returns textual descriptions of the results of the last conversion operation.
std::vector< NXStringGetResults (bool showAllResults)
 Returns textual descriptions of the results of all prior conversion operations for all the parts described by the current context set using Positioning::MatingConverter::SetContext .
bool LoadReferencedGeometry ()
 Returns whether to load unloaded referenced geometry before performing a conversion.
NXOpen::PartLoadStatusLoadStatus ()
 Returns the load status resulting from a conversion operation.
int NumberOfConvertedParts ()
 Returns the number of parts parts converted by this conversion operation.
void SetContext (NXOpen::Positioning::MatingConverter::PartContext context)
 Sets the current conversion context in which mating conditions will be converted.
void SetLoadReferencedGeometry (bool loadGeometry)
 Sets whether to load unloaded referenced geometry before performing a conversion.

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 Assemblies::ComponentAssembly from which this object was obtained using 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:
PartContextInOwningPart 

Convert mating conditions in the owning part.

PartContextInLoadedChildren 

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

Partially-loaded children will be fully-loaded.

PartContextInAllChildren 

Convert mating conditions in the owning part and all children.

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


Member Function Documentation

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


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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 Positioning::MatingConverter::SetContext ). 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")

Deletes this Positioning::MatingConverter immediately.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns all constraints converted by this conversion operation.

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

Returns:
The converted constraints
Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns all parts converted by this conversion operation.

Returns:
The converted constraints
Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns textual descriptions of the results of the last conversion operation.

Returns:
The generated results
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
std::vector<NXString> 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 Positioning::MatingConverter::SetContext .

Returns:
The generated results
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 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 : assemblies ("ASSEMBLIES MODULE")

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")

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


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Sets the current conversion context in which mating conditions will be converted.


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
contextThe new context

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 : assemblies ("ASSEMBLIES MODULE")

Parameters:
loadGeometryWhether to load referenced-geometry

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