Represents NXOpen.Assemblies.ClearanceAnalysisBuilder . More...

Inheritance diagram for NXOpen.Assemblies.ClearanceAnalysisBuilder:

Public Types
enum	CalculationMethodType { Lightweight, ExactifLoaded, Exact }
	Specify the analysis method. More...

enum	ClearanceBetweenEntity { Components, Bodies }
	Specify the type of clearance analysis. More...

enum	ClearanceZoneSource { Pair, Object1, Object2, Default, Defined }
	Specify the source of the clearance zone More...

enum	CollectionRange { AllObjects, AllVisibleObjects, SelectedObjects, AllButSelectedObjects }
	Specify how to compare objects inside a collection. More...

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

enum	PairExcludedReason { NoReason, UserDefined, SameCompRule, SameGroupRule, MatedCompRule, SamePartRule, CompSuppressed, NonGeom, UnitSubassy }
	Specify the reason for excluding the pair More...

enum	ZoneType { Object, Pair }
	Specify the clearance zone type. More...

Public Member Functions
unsafe void	AddException (bool isExclude, NXOpen.DisplayableObject comp1, NXOpen.DisplayableObject comp2, string text)
	Add an exception. More...

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

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

unsafe NXOpen.Expression	CreateClearanceZoneExpression (string rhsExpression)
	Create an expression using the Clearance Zone naming convention. More...

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

unsafe void	DeleteObjectClearanceZone (NXOpen.DisplayableObject @object)
	Delete an existing Clearance Zone from around an object. More...

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

unsafe NXOpen.Expression	GetDefaultClearanceZone ()
	Get the default Clearance Zone expression. More...

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

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource	GetObjectClearanceZone (NXOpen.DisplayableObject @object, out NXOpen.Expression expression)
	Inquire the Clearance Zone assigned to a given object. More...

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

unsafe void	SetDefaultClearanceZone (NXOpen.Expression expression)
	Set the expression as the default Clearance Zone. More...

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

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

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

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

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.CalculationMethodType	CalculationMethod `[get, set]`
	Returns or sets the setting for the clearance calculation method. More...

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceBetweenEntity	ClearanceBetween `[get, set]`
	Returns or sets the setting to determine whether components or bodies should be used. More...

unsafe string	ClearanceSetName `[get, set]`
	Returns or sets the clearance set name. More...

unsafe NXOpen.SelectDisplayableObjectList	CollectionOneObjects `[get]`
	Returns the selected objects for collection one. More...

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionRange	CollectionOneRange `[get, set]`
	Returns or sets the range setting for collection one. More...

unsafe NXOpen.SelectDisplayableObjectList	CollectionTwoObjects `[get]`
	Returns the selected objects for collection two. More...

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionRange	CollectionTwoRange `[get, set]`
	Returns or sets the range setting for collection two. More...

unsafe NXOpen.NXColor	InterferenceColor `[get, set]`
	Returns or sets the color of the interference geometry. More...

unsafe bool	IsCalculatePenetrationDepth `[get, set]`
	Returns or sets the setting to determine whether penetration depth should be calculated. More...

unsafe bool	IsIgnorePairsWithinSameGroup `[get, set]`
	Returns or sets the setting to determine whether to ignore pairs within same group. More...

unsafe bool	IsIgnorePairsWithinSamePart `[get, set]`
	Returns or sets the setting to determine whether to ignore pairs within same part. More...

unsafe bool	IsIgnorePairsWithinSameSubassembly `[get, set]`
	Returns or sets the setting to determine whether to ignore pairs within same subassembly. More...

unsafe bool	IsIgnorePairsWithinSelectedSubassemblies `[get, set]`
	Returns or sets the setting to determine whether to ignore pairs within the selected subassemblies. More...

unsafe int	Layer `[get, set]`
	Returns or sets the layer for interference geometry. More...

unsafe bool	SaveInterferenceGeometry `[get, set]`
	Returns or sets the setting to determine if interference geometry should be saved. More...

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.NumberOfCollections	TotalCollectionCount `[get, set]`
	Returns or sets the setting to determine whether one collection or two collections should be used. More...

unsafe NXOpen.SelectDisplayableObjectList	UnitSubassemblies `[get]`
	Returns the selected unit subassemblies. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents NXOpen.Assemblies.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 or PSM facet objects.

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 NXOpen.Assemblies.AssemblyManager.CreateClearanceAnalysisBuilder

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.CalculationMethodType

Specify the analysis method.

Enumerator
Lightweight
ExactifLoaded
Exact

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceBetweenEntity

Specify the type of clearance analysis.

Enumerator
Components
Bodies

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource

Specify the source of the clearance zone

Enumerator
Pair
Object1
Object2
Default
Defined

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionRange

Specify how to compare objects inside a collection.

Enumerator
AllObjects
AllVisibleObjects
SelectedObjects
AllButSelectedObjects

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.NumberOfCollections

Specify the number of collections used for clearance analysis.

Enumerator
One
Two

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.PairExcludedReason

Specify the reason for excluding the pair

Enumerator
NoReason	default behavior
UserDefined	user has explicitly included or excluded this pair
SameCompRule	global exclusion rule for same component applies
SameGroupRule	global exclusion rule for same group applies
MatedCompRule	global exclusion rule for mated component applies
SamePartRule	global exclusion rule for same part applies
CompSuppressed	suppressed component
NonGeom	no geometry
UnitSubassy	in unit subassembly

enum NXOpen.Assemblies.ClearanceAnalysisBuilder.ZoneType

Specify the clearance zone type.

Enumerator
Object
Pair

Member Function Documentation

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.AddException	(	bool	isExclude,
		NXOpen.DisplayableObject	comp1,
		NXOpen.DisplayableObject	comp2,
		string	text
	)

inline

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

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.AddObjectClearanceZone	(	NXOpen.DisplayableObject @	object,
		NXOpen.Expression	expression
	)

inline

Add a Clearance Zone around an object.

Create the expression using CreateClearanceZoneExpression 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

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.AddPairClearanceZone	(	NXOpen.DisplayableObject	object1,
		NXOpen.DisplayableObject	object2,
		NXOpen.Expression	expression
	)

inline

Add a Clearance Zone between a pair of objects.

Create the expression using CreateClearanceZoneExpression 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

unsafe NXOpen.Expression NXOpen.Assemblies.ClearanceAnalysisBuilder.CreateClearanceZoneExpression ( string rhsExpression )

inline

Create an expression using the Clearance Zone naming convention.

The expression is intended for use in the following methods: NXOpen.Assemblies.ClearanceAnalysisBuilder.SetDefaultClearanceZone NXOpen.Assemblies.ClearanceAnalysisBuilder.AddPairClearanceZone NXOpen.Assemblies.ClearanceAnalysisBuilder.AddObjectClearanceZone

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

rhsExpression the text for the expression

Returns: the new expression

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.DeleteException	(	NXOpen.DisplayableObject	comp1,
		NXOpen.DisplayableObject	comp2
	)

inline

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

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.DeleteObjectClearanceZone ( NXOpen.DisplayableObject @ object )

inline

Delete an existing Clearance Zone from around an object.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

object the object

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.DeletePairClearanceZone	(	NXOpen.DisplayableObject	object1,
		NXOpen.DisplayableObject	object2
	)

inline

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

unsafe NXOpen.Expression NXOpen.Assemblies.ClearanceAnalysisBuilder.GetDefaultClearanceZone ( )

inline

Get the default Clearance Zone expression.

If there is no expression set previously, a a null reference (Nothing in Visual Basic) will be returned.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: the expression

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.GetIsPairIncluded	(	NXOpen.DisplayableObject	object1,
		NXOpen.DisplayableObject	object2,
		out NXOpen.Assemblies.ClearanceAnalysisBuilder.PairExcludedReason	reason,
		out string	text
	)

inline

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 NXOpen.Assemblies.ClearanceAnalysisBuilder.PairExcludedReason.UserDefined reason.

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

Returns: the flag

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource NXOpen.Assemblies.ClearanceAnalysisBuilder.GetObjectClearanceZone	(	NXOpen.DisplayableObject @	object,
		out NXOpen.Expression	expression
	)

inline

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, a null reference (Nothing in Visual Basic) 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. NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource.Defined specifies that the object has its own Clearance Zone. NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource.Default means the default clearance zone is used.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

object	the object
expression	the expression

Returns: the source of the clearance zone

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource NXOpen.Assemblies.ClearanceAnalysisBuilder.GetPairClearanceZone	(	NXOpen.DisplayableObject	object1,
		NXOpen.DisplayableObject	object2,
		out NXOpen.Expression	expression
	)

inline

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 (NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource.Object1 or NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource.Object2 . NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource.Pair means this pair has its own explicit clearance zone. NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceZoneSource.Default means the default clearance zone is used..

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

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

Returns: the source of the clearance zone

unsafe void NXOpen.Assemblies.ClearanceAnalysisBuilder.SetDefaultClearanceZone ( NXOpen.Expression expression )

inline

Set the expression as the default Clearance Zone.

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

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

expression the expression

Property Documentation

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.CalculationMethodType NXOpen.Assemblies.ClearanceAnalysisBuilder.CalculationMethod

getset

Returns or sets the setting for the clearance calculation method.

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceBetweenEntity NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceBetween

getset

Returns or 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 to get this property: None.

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

unsafe string NXOpen.Assemblies.ClearanceAnalysisBuilder.ClearanceSetName

getset

Returns or sets the clearance set name.

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.SelectDisplayableObjectList NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionOneObjects

get

Returns the selected objects for collection one.

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionRange NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionOneRange

getset

Returns or sets the range setting for collection one.

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.SelectDisplayableObjectList NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionTwoObjects

get

Returns the selected objects for collection two.

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionRange NXOpen.Assemblies.ClearanceAnalysisBuilder.CollectionTwoRange

getset

Returns or sets the range setting for collection two.

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.NXColor NXOpen.Assemblies.ClearanceAnalysisBuilder.InterferenceColor

getset

Returns or sets the color of the interference geometry.

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.IsCalculatePenetrationDepth

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.IsIgnorePairsWithinSameGroup

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.IsIgnorePairsWithinSamePart

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.IsIgnorePairsWithinSameSubassembly

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.IsIgnorePairsWithinSelectedSubassemblies

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe int NXOpen.Assemblies.ClearanceAnalysisBuilder.Layer

getset

Returns or sets the layer for interference geometry.

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Assemblies.ClearanceAnalysisBuilder.SaveInterferenceGeometry

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Assemblies.ClearanceAnalysisBuilder.NumberOfCollections NXOpen.Assemblies.ClearanceAnalysisBuilder.TotalCollectionCount

getset

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

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.SelectDisplayableObjectList NXOpen.Assemblies.ClearanceAnalysisBuilder.UnitSubassemblies

get

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

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation