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

void	ConvertMatingConditions ()
	Converts Mating Conditions to Assembly Constraints according to the properties defined on this NXOpen::Positioning::MatingConverter object. More...

void	DeleteResults ()
	Removes details from the mating conversion results of the individual constraints that were converted. More...

void	Destroy ()
	Deletes this NXOpen::Positioning::MatingConverter immediately. More...

std::vector < NXOpen::Positioning::Constraint * >	GetConvertedConstraints ()
	Returns all constraints converted by this conversion operation. More...

std::vector < NXOpen::Positioning::Constraint * >	GetConvertedParts ()
	Returns all parts converted by this conversion operation. More...

std::vector< NXString >	GetLatestResults (bool showAllResults)
	Returns textual descriptions of the results of the last conversion operation. More...

std::vector< NXString >	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::SetContext . More...

bool	LoadReferencedGeometry ()
	Returns whether to load unloaded referenced geometry before performing a conversion. More...

NXOpen::PartLoadStatus *	LoadStatus ()
	Returns the load status resulting from a conversion operation. More...

int	NumberOfConvertedParts ()
	Returns the number of parts parts converted by this conversion operation. More...

void	SetContext (NXOpen::Positioning::MatingConverter::PartContext context)
	Sets the current conversion context in which mating conditions will be converted. More...

void	SetLoadReferencedGeometry (bool loadGeometry)
	Sets whether to load unloaded referenced geometry before performing a conversion. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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

enum NXOpen::Positioning::MatingConverter::PartContext

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

NXOpen::Positioning::MatingConverter::PartContext NXOpen::Positioning::MatingConverter::Context ( )

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

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

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

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

void NXOpen::Positioning::MatingConverter::Destroy ( )

Deletes this NXOpen::Positioning::MatingConverter immediately.

Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

std::vector<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.

Returns: The converted constraints
Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

std::vector<NXOpen::Positioning::Constraint *> NXOpen::Positioning::MatingConverter::GetConvertedParts ( )

Returns all parts converted by this conversion operation.

Returns: The converted constraints
Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

std::vector<NXString> NXOpen::Positioning::MatingConverter::GetLatestResults ( bool showAllResults )

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

showAllResults Whether 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 NXOpen::Positioning::MatingConverter::SetContext .

Returns: The generated results
Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

showAllResults Whether to show results for all converted constraints even if no issues arose during their conversion

bool NXOpen::Positioning::MatingConverter::LoadReferencedGeometry ( )

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

NXOpen::PartLoadStatus* NXOpen::Positioning::MatingConverter::LoadStatus ( )

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

int NXOpen::Positioning::MatingConverter::NumberOfConvertedParts ( )

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

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Positioning::MatingConverter::SetContext ( NXOpen::Positioning::MatingConverter::PartContext context )

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

Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

context The new context

void NXOpen::Positioning::MatingConverter::SetLoadReferencedGeometry ( bool loadGeometry )

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

loadGeometry Whether to load referenced-geometry

The documentation for this class was generated from the following file:

Positioning_MatingConverter.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation