Represents ClearanceAnalysisBuilder . More...

Inheritance diagram for NXOpen::Assemblies::ClearanceAnalysisBuilder:

Public Types
enum	CalculationMethodType { CalculationMethodTypeLightweight, CalculationMethodTypeExactifLoaded, CalculationMethodTypeExact }
	Specify the analysis method. More...

enum	ClearanceBetweenEntity { ClearanceBetweenEntityComponents, ClearanceBetweenEntityBodies }
	Specify the type of clearance analysis. More...

enum	ClearanceZoneSource { ClearanceZoneSourcePair, ClearanceZoneSourceObject1, ClearanceZoneSourceObject2, ClearanceZoneSourceDefault, ClearanceZoneSourceDefined }
	Specify the source of the clearance zone. More...

enum	CollectionRange { CollectionRangeAllObjects, CollectionRangeAllVisibleObjects, CollectionRangeSelectedObjects, CollectionRangeAllButSelectedObjects }
	Specify how to compare objects inside a collection. More...

enum	NumberOfCollections { NumberOfCollectionsOne, NumberOfCollectionsTwo }
	Specify the number of collections used for clearance analysis. More...

enum	PairExcludedReason { PairExcludedReasonNoReason, PairExcludedReasonUserDefined, PairExcludedReasonSameCompRule, PairExcludedReasonSameGroupRule, PairExcludedReasonMatedCompRule, PairExcludedReasonSamePartRule, PairExcludedReasonCompSuppressed, PairExcludedReasonNonGeom, PairExcludedReasonUnitSubassy }
	Specify the reason for excluding the pair. More...

enum	ZoneType { ZoneTypeObject, ZoneTypePair }
	Specify the clearance zone type. More...

Public Member Functions
void	AddException (bool isExclude, NXOpen::DisplayableObject comp1, NXOpen::DisplayableObject comp2, const NXString &text)
	Add an exception.

void	AddException (bool isExclude, NXOpen::DisplayableObject comp1, NXOpen::DisplayableObject comp2, const char *text)
	Add an exception.

void	AddObjectClearanceZone (NXOpen::DisplayableObject object, NXOpen::Expression expression)
	Add a Clearance Zone around an object.

void	AddPairClearanceZone (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, NXOpen::Expression *expression)
	Add a Clearance Zone between a pair of objects.

NXOpen::Assemblies::ClearanceAnalysisBuilder::CalculationMethodType	CalculationMethod ()
	Returns the setting for the clearance calculation method.

NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceBetweenEntity	ClearanceBetween ()
	Returns the setting to determine whether components or bodies should be used.

NXString	ClearanceSetName ()
	Returns the clearance set name.

NXOpen::SelectDisplayableObjectList *	CollectionOneObjects ()
	Returns the selected objects for collection one.

NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange	CollectionOneRange ()
	Returns the range setting for collection one.

NXOpen::SelectDisplayableObjectList *	CollectionTwoObjects ()
	Returns the selected objects for collection two.

NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange	CollectionTwoRange ()
	Returns the range setting for collection two.

NXOpen::Expression *	CreateClearanceZoneExpression (const NXString &rhsExpression)
	Create an expression using the Clearance Zone naming convention.

NXOpen::Expression *	CreateClearanceZoneExpression (const char *rhsExpression)
	Create an expression using the Clearance Zone naming convention.

void	DeleteException (NXOpen::DisplayableObject comp1, NXOpen::DisplayableObject comp2)
	Delete an exception.

void	DeleteObjectClearanceZone (NXOpen::DisplayableObject *object)
	Delete an existing Clearance Zone from around an object.

void	DeletePairClearanceZone (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2)
	Delete an existing Clearance Zone between the given pair of objects.

NXOpen::Expression *	GetDefaultClearanceZone ()
	Get the default Clearance Zone expression.

bool	GetIsPairIncluded (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, NXOpen::Assemblies::ClearanceAnalysisBuilder::PairExcludedReason reason, NXString text)
	Inquires if an object pair is to be included in the analysis.

NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource	GetObjectClearanceZone (NXOpen::DisplayableObject object, NXOpen::Expression *expression)
	Inquire the Clearance Zone assigned to a given object.

NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource	GetPairClearanceZone (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, NXOpen::Expression **expression)
	Inquire the Clearance Zone for a specific pair of objects.

NXOpen::NXColor *	InterferenceColor ()
	Returns the color of the interference geometry.

bool	IsCalculatePenetrationDepth ()
	Returns the setting to determine whether penetration depth should be calculated.

bool	IsIgnorePairsWithinSameGroup ()
	Returns the setting to determine whether to ignore pairs within same group.

bool	IsIgnorePairsWithinSamePart ()
	Returns the setting to determine whether to ignore pairs within same part.

bool	IsIgnorePairsWithinSameSubassembly ()
	Returns the setting to determine whether to ignore pairs within same subassembly.

bool	IsIgnorePairsWithinSelectedSubassemblies ()
	Returns the setting to determine whether to ignore pairs within the selected subassemblies.

int	Layer ()
	Returns the layer for interference geometry.

bool	SaveInterferenceGeometry ()
	Returns the setting to determine if interference geometry should be saved.

void	SetCalculatePenetrationDepth (bool isCalculatePenetrationDepth)
	Sets the setting to determine whether penetration depth should be calculated.

void	SetCalculationMethod (NXOpen::Assemblies::ClearanceAnalysisBuilder::CalculationMethodType calculateMethod)
	Sets the setting for the clearance calculation method.

void	SetClearanceBetween (NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceBetweenEntity clearanceBetweenEntity)
	Sets the setting to determine whether components or bodies should be used.

void	SetClearanceSetName (const NXString &clearanceSetName)
	Sets the clearance set name.

void	SetClearanceSetName (const char *clearanceSetName)
	Sets the clearance set name.

void	SetCollectionOneRange (NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange collectionRange)
	Sets the range setting for collection one.

void	SetCollectionTwoRange (NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange collectionRange)
	Sets the range setting for collection two.

void	SetDefaultClearanceZone (NXOpen::Expression *expression)
	Set the expression as the default Clearance Zone.

void	SetIgnorePairsWithinSameGroup (bool isIgnorePairsWithinSameGroup)
	Sets the setting to determine whether to ignore pairs within same group.

void	SetIgnorePairsWithinSamePart (bool isIgnorePairsWithinSamePart)
	Sets the setting to determine whether to ignore pairs within same part.

void	SetIgnorePairsWithinSameSubassembly (bool isIgnorePairsWithinSameSubassembly)
	Sets the setting to determine whether to ignore pairs within same subassembly.

void	SetIgnorePairsWithinSelectedSubassemblies (bool isIgnorePairsWithinSelectedSubassemblies)
	Sets the setting to determine whether to ignore pairs within the selected subassemblies.

void	SetInterferenceColor (NXOpen::NXColor *color)
	Sets the color of the interference geometry.

void	SetLayer (int layer)
	Sets the layer for interference geometry.

void	SetSaveInterferenceGeometry (bool saveInterferenceGeometry)
	Sets the setting to determine if interference geometry should be saved.

void	SetTotalCollectionCount (NXOpen::Assemblies::ClearanceAnalysisBuilder::NumberOfCollections totalCollectionCount)
	Sets the setting to determine whether one collection or two collections should be used.

NXOpen::Assemblies::ClearanceAnalysisBuilder::NumberOfCollections	TotalCollectionCount ()
	Returns the setting to determine whether one collection or two collections should be used.

NXOpen::SelectDisplayableObjectList *	UnitSubassemblies ()
	Returns the selected unit subassemblies.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents ClearanceAnalysisBuilder .

The builder builds the clearance set which contains properties for the analysis. The properties are:

Clearance Set Name: the name of the clearance set.

Clearance Type: either components or bodies.

Number of collections: either one or two. Where one collection is chosen, the analysis is performed between all objects in the collection. Where two collections are chosen, the analysis compares objects from one collection with objects from the other.

Exceptions: Select Subassemblies: Specific subassemblies selected within the displayed part can be treated as a single entity.

Explicitly Ignore: A number of options to reduce the amount of results reported.

Additional exceptions: Addtional pairs of objects to be excluded or included regardless of exception rules previously defined.
To create a new instance of this class, use Assemblies::AssemblyManager::CreateClearanceAnalysisBuilder

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::CalculationMethodType

Specify the analysis method.

Enumerator:

CalculationMethodTypeLightweight	lightweight
CalculationMethodTypeExactifLoaded	exactif loaded
CalculationMethodTypeExact	exact

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceBetweenEntity

Specify the type of clearance analysis.

Enumerator:

ClearanceBetweenEntityComponents	components
ClearanceBetweenEntityBodies	bodies

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource

Specify the source of the clearance zone.

Enumerator:

ClearanceZoneSourcePair	pair
ClearanceZoneSourceObject1	object1
ClearanceZoneSourceObject2	object2
ClearanceZoneSourceDefault	default
ClearanceZoneSourceDefined	defined

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange

Specify how to compare objects inside a collection.

Enumerator:

CollectionRangeAllObjects	all objects
CollectionRangeAllVisibleObjects	all visible objects
CollectionRangeSelectedObjects	selected objects
CollectionRangeAllButSelectedObjects	all but selected objects

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::NumberOfCollections

Specify the number of collections used for clearance analysis.

Enumerator:

NumberOfCollectionsOne	one
NumberOfCollectionsTwo	two

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::PairExcludedReason

Specify the reason for excluding the pair.

Enumerator:

PairExcludedReasonNoReason	default behavior
PairExcludedReasonUserDefined	user has explicitly included or excluded this pair
PairExcludedReasonSameCompRule	global exclusion rule for same component applies
PairExcludedReasonSameGroupRule	global exclusion rule for same group applies
PairExcludedReasonMatedCompRule	global exclusion rule for mated component applies
PairExcludedReasonSamePartRule	global exclusion rule for same part applies
PairExcludedReasonCompSuppressed	suppressed component
PairExcludedReasonNonGeom	no geometry
PairExcludedReasonUnitSubassy	in unit subassembly

enum NXOpen::Assemblies::ClearanceAnalysisBuilder::ZoneType

Specify the clearance zone type.

Enumerator:

ZoneTypeObject	object
ZoneTypePair	pair

Member Function Documentation

void NXOpen::Assemblies::ClearanceAnalysisBuilder::AddException	(	bool	isExclude,
		NXOpen::DisplayableObject *	comp1,
		NXOpen::DisplayableObject *	comp2,
		const NXString &	text
	)

Add an exception.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isExclude	exclude or include type of the exception
comp1	the first object of the pair
comp2	the second object of the pair
text	note for the exception NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ClearanceAnalysisBuilder::AddException	(	bool	isExclude,
		NXOpen::DisplayableObject *	comp1,
		NXOpen::DisplayableObject *	comp2,
		const char *	text
	)

Add an exception.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isExclude	exclude or include type of the exception
comp1	the first object of the pair
comp2	the second object of the pair
text	note for the exception NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ClearanceAnalysisBuilder::AddObjectClearanceZone	(	NXOpen::DisplayableObject *	object,
		NXOpen::Expression *	expression
	)

Add a Clearance Zone around an object.

       Create the expression using @link CreateClearanceZoneExpression CreateClearanceZoneExpression@endlink  
       if the Clearance Zone expression naming convention is desired.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object	the object
expression	the expression

void NXOpen::Assemblies::ClearanceAnalysisBuilder::AddPairClearanceZone	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		NXOpen::Expression *	expression
	)

Add a Clearance Zone between a pair of objects.

       Create the expression using @link CreateClearanceZoneExpression CreateClearanceZoneExpression@endlink  
       if the Clearance Zone expression naming convention is desired.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object
object2	the second object
expression	the expression

NXOpen::Assemblies::ClearanceAnalysisBuilder::CalculationMethodType NXOpen::Assemblies::ClearanceAnalysisBuilder::CalculationMethod ( )

Returns the setting for the clearance calculation method.

Created in NX9.0.0.

License requirements : None

NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceBetweenEntity NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceBetween ( )

Returns the setting to determine whether components or bodies should be used.

       Please note that changing the collection type will clear the collections, 
       exceptions and clearance zones from the clearance set

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceSetName ( )

Returns the clearance set name.

Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionOneObjects ( )

Returns the selected objects for collection one.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionOneRange ( )

Returns the range setting for collection one.

Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionTwoObjects ( )

Returns the selected objects for collection two.

Created in NX9.0.0.

License requirements : None

NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionTwoRange ( )

Returns the range setting for collection two.

Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Assemblies::ClearanceAnalysisBuilder::CreateClearanceZoneExpression ( const NXString & rhsExpression )

Create an expression using the Clearance Zone naming convention.

       The expression is intended for use in the following methods:
       @link Assemblies::ClearanceAnalysisBuilder::SetDefaultClearanceZone Assemblies::ClearanceAnalysisBuilder::SetDefaultClearanceZone@endlink  
       @link Assemblies::ClearanceAnalysisBuilder::AddPairClearanceZone Assemblies::ClearanceAnalysisBuilder::AddPairClearanceZone@endlink  
       @link Assemblies::ClearanceAnalysisBuilder::AddObjectClearanceZone Assemblies::ClearanceAnalysisBuilder::AddObjectClearanceZone@endlink   @return  the new expression

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

rhsExpression the text for the expression
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::Expression* NXOpen::Assemblies::ClearanceAnalysisBuilder::CreateClearanceZoneExpression ( const char * rhsExpression )

Create an expression using the Clearance Zone naming convention.

       The expression is intended for use in the following methods:
       @link Assemblies::ClearanceAnalysisBuilder::SetDefaultClearanceZone Assemblies::ClearanceAnalysisBuilder::SetDefaultClearanceZone@endlink  
       @link Assemblies::ClearanceAnalysisBuilder::AddPairClearanceZone Assemblies::ClearanceAnalysisBuilder::AddPairClearanceZone@endlink  
       @link Assemblies::ClearanceAnalysisBuilder::AddObjectClearanceZone Assemblies::ClearanceAnalysisBuilder::AddObjectClearanceZone@endlink   @return  the new expression

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

rhsExpression the text for the expression
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ClearanceAnalysisBuilder::DeleteException	(	NXOpen::DisplayableObject *	comp1,
		NXOpen::DisplayableObject *	comp2
	)

Delete an exception.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

comp1	the first object of the pair
comp2	the second object of the pair

void NXOpen::Assemblies::ClearanceAnalysisBuilder::DeleteObjectClearanceZone ( NXOpen::DisplayableObject * object )

Delete an existing Clearance Zone from around an object.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object the object

void NXOpen::Assemblies::ClearanceAnalysisBuilder::DeletePairClearanceZone	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2
	)

Delete an existing Clearance Zone between the given pair of objects.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object
object2	the second object

NXOpen::Expression* NXOpen::Assemblies::ClearanceAnalysisBuilder::GetDefaultClearanceZone ( )

Get the default Clearance Zone expression.

       If there is no expression set previously, a NULL will be returned.  @return  the expression

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::GetIsPairIncluded	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		NXOpen::Assemblies::ClearanceAnalysisBuilder::PairExcludedReason *	reason,
		NXString *	text
	)

Inquires if an object pair is to be included in the analysis.

Both objects must be solid bodies or facet models that are members of the clearance analysis data set. If the pair is to be analyzed, the includeIt is returned as TRUE. The reason parameter signifies why the pair is included or excluded. The text parameter is only returned for the Assemblies::ClearanceAnalysisBuilder::PairExcludedReason::UserDefined reason.

Returns: the flag
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object
object2	the second object
reason	the reason
text	the text

NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource NXOpen::Assemblies::ClearanceAnalysisBuilder::GetObjectClearanceZone	(	NXOpen::DisplayableObject *	object,
		NXOpen::Expression **	expression
	)

Inquire the Clearance Zone assigned to a given object.

The object must be a member of the dataset. The expression, the distance, and the source are the outputs. If no expression has ever been set, the part of the given object is checked for a Clearance Zone expression, if none is found, NULL will be returned for the expression. Interpret its value as 0.0 (this is the default value). The source parameter tells where the clearance zone comes from. Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource::Defined specifies that the object has its own Clearance Zone. Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource::Default means the default clearance zone is used.

Returns: the source of the clearance zone
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object	the object
expression	the expression

NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource NXOpen::Assemblies::ClearanceAnalysisBuilder::GetPairClearanceZone	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		NXOpen::Expression **	expression
	)

Inquire the Clearance Zone for a specific pair of objects.

Both objects must be members of the Clearance Set. The source parameter tells where the clearance zone comes from. The clearance zone could be the greater of the zones from object 1 or 2 (Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource::Object1 or Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource::Object2 . Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource::Pair means this pair has its own explicit clearance zone. Assemblies::ClearanceAnalysisBuilder::ClearanceZoneSource::Default means the default clearance zone is used..

Returns: the source of the clearance zone
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object
object2	the second object
expression	the corresponding expression

NXOpen::NXColor* NXOpen::Assemblies::ClearanceAnalysisBuilder::InterferenceColor ( )

Returns the color of the interference geometry.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::IsCalculatePenetrationDepth ( )

Returns the setting to determine whether penetration depth should be calculated.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::IsIgnorePairsWithinSameGroup ( )

Returns the setting to determine whether to ignore pairs within same group.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::IsIgnorePairsWithinSamePart ( )

Returns the setting to determine whether to ignore pairs within same part.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::IsIgnorePairsWithinSameSubassembly ( )

Returns the setting to determine whether to ignore pairs within same subassembly.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::IsIgnorePairsWithinSelectedSubassemblies ( )

Returns the setting to determine whether to ignore pairs within the selected subassemblies.

Created in NX9.0.0.

License requirements : None

int NXOpen::Assemblies::ClearanceAnalysisBuilder::Layer ( )

Returns the layer for interference geometry.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ClearanceAnalysisBuilder::SaveInterferenceGeometry ( )

Returns the setting to determine if interference geometry should be saved.

Created in NX9.0.0.

License requirements : None

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetCalculatePenetrationDepth ( bool isCalculatePenetrationDepth )

Sets the setting to determine whether penetration depth should be calculated.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isCalculatePenetrationDepth iscalculatepenetrationdepth

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetCalculationMethod ( NXOpen::Assemblies::ClearanceAnalysisBuilder::CalculationMethodType calculateMethod )

Sets the setting for the clearance calculation method.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

calculateMethod calculatemethod

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetClearanceBetween ( NXOpen::Assemblies::ClearanceAnalysisBuilder::ClearanceBetweenEntity clearanceBetweenEntity )

Sets the setting to determine whether components or bodies should be used.

       Please note that changing the collection type will clear the collections, 
       exceptions and clearance zones from the clearance set

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

clearanceBetweenEntity clearancebetweenentity

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetClearanceSetName ( const NXString & clearanceSetName )

Sets the clearance set name.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

clearanceSetName clearancesetname

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetClearanceSetName ( const char * clearanceSetName )

Sets the clearance set name.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

clearanceSetName clearancesetname

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetCollectionOneRange ( NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange collectionRange )

Sets the range setting for collection one.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

collectionRange collectionrange

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetCollectionTwoRange ( NXOpen::Assemblies::ClearanceAnalysisBuilder::CollectionRange collectionRange )

Sets the range setting for collection two.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

collectionRange collectionrange

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetDefaultClearanceZone ( NXOpen::Expression * expression )

Set the expression as the default Clearance Zone.

       Create the expression using @link CreateClearanceZoneExpression CreateClearanceZoneExpression@endlink  
       if the Clearance Zone expression naming convention is desired.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

expression the expression

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetIgnorePairsWithinSameGroup ( bool isIgnorePairsWithinSameGroup )

Sets the setting to determine whether to ignore pairs within same group.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isIgnorePairsWithinSameGroup isignorepairswithinsamegroup

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetIgnorePairsWithinSamePart ( bool isIgnorePairsWithinSamePart )

Sets the setting to determine whether to ignore pairs within same part.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isIgnorePairsWithinSamePart isignorepairswithinsamepart

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetIgnorePairsWithinSameSubassembly ( bool isIgnorePairsWithinSameSubassembly )

Sets the setting to determine whether to ignore pairs within same subassembly.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isIgnorePairsWithinSameSubassembly isignorepairswithinsamesubassembly

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetIgnorePairsWithinSelectedSubassemblies ( bool isIgnorePairsWithinSelectedSubassemblies )

Sets the setting to determine whether to ignore pairs within the selected subassemblies.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isIgnorePairsWithinSelectedSubassemblies isignorepairswithinselectedsubassemblies

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetInterferenceColor ( NXOpen::NXColor * color )

Sets the color of the interference geometry.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

color color

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetLayer ( int layer )

Sets the layer for interference geometry.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

layer layer

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetSaveInterferenceGeometry ( bool saveInterferenceGeometry )

Sets the setting to determine if interference geometry should be saved.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

saveInterferenceGeometry saveinterferencegeometry

void NXOpen::Assemblies::ClearanceAnalysisBuilder::SetTotalCollectionCount ( NXOpen::Assemblies::ClearanceAnalysisBuilder::NumberOfCollections totalCollectionCount )

Sets the setting to determine whether one collection or two collections should be used.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

totalCollectionCount totalcollectioncount

NXOpen::Assemblies::ClearanceAnalysisBuilder::NumberOfCollections NXOpen::Assemblies::ClearanceAnalysisBuilder::TotalCollectionCount ( )

Returns the setting to determine whether one collection or two collections should be used.

Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::ClearanceAnalysisBuilder::UnitSubassemblies ( )

Returns the selected unit subassemblies.

Created in NX9.0.0.

License requirements : None

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

Assemblies_ClearanceAnalysisBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation