nxopen.assemblies

Interface ClearanceAnalysisBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface ClearanceAnalysisBuilder
extends Builder

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 AssemblyManager.createClearanceAnalysisBuilder(nxopen.assemblies.ClearanceSet)

Created in NX9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClearanceAnalysisBuilder.CalculationMethodType Specify the analysis method.
static class	ClearanceAnalysisBuilder.ClearanceBetweenEntity Specify the type of clearance analysis.
static class	ClearanceAnalysisBuilder.ClearanceZoneSource Specify the source of the clearance zone
static class	ClearanceAnalysisBuilder.CollectionRange Specify how to compare objects inside a collection.
static class	ClearanceAnalysisBuilder.IsPairIncludedData This class holds the data returned from getIsPairIncluded(nxopen.DisplayableObject, nxopen.DisplayableObject)
static class	ClearanceAnalysisBuilder.NumberOfCollections Specify the number of collections used for clearance analysis.
static class	ClearanceAnalysisBuilder.PairClearanceZoneData This class holds the data returned from getPairClearanceZone(nxopen.DisplayableObject, nxopen.DisplayableObject)
static class	ClearanceAnalysisBuilder.PairExcludedReason Specify the reason for excluding the pair
static class	ClearanceAnalysisBuilder.ZoneType Specify the clearance zone type.

Method Summary

Modifier and Type	Method and Description
void	addException(boolean isExclude, DisplayableObject comp1, DisplayableObject comp2, String text) Add an exception.
void	addObjectClearanceZone(DisplayableObject object, Expression expression) Add a Clearance Zone around an object.
void	addPairClearanceZone(DisplayableObject object1, DisplayableObject object2, Expression expression) Add a Clearance Zone between a pair of objects.
ClearanceAnalysisBuilder.CalculationMethodType	calculationMethod() Returns the setting for the clearance calculation method.
ClearanceAnalysisBuilder.ClearanceBetweenEntity	clearanceBetween() Returns the setting to determine whether components or bodies should be used.
String	clearanceSetName() Returns the clearance set name.
SelectDisplayableObjectList	collectionOneObjects() Returns the selected objects for collection one.
ClearanceAnalysisBuilder.CollectionRange	collectionOneRange() Returns the range setting for collection one.
SelectDisplayableObjectList	collectionTwoObjects() Returns the selected objects for collection two.
ClearanceAnalysisBuilder.CollectionRange	collectionTwoRange() Returns the range setting for collection two.
Expression	createClearanceZoneExpression(String rhsExpression) Create an expression using the Clearance Zone naming convention.
void	deleteException(DisplayableObject comp1, DisplayableObject comp2) Delete an exception.
void	deleteObjectClearanceZone(DisplayableObject object) Delete an existing Clearance Zone from around an object.
void	deletePairClearanceZone(DisplayableObject object1, DisplayableObject object2) Delete an existing Clearance Zone between the given pair of objects.
Expression	getDefaultClearanceZone() Get the default Clearance Zone expression.
ClearanceAnalysisBuilder.IsPairIncludedData	getIsPairIncluded(DisplayableObject object1, DisplayableObject object2) Inquires if an object pair is to be included in the analysis.
ClearanceAnalysisBuilder.PairClearanceZoneData	getObjectClearanceZone(DisplayableObject object) Inquire the Clearance Zone assigned to a given object.
ClearanceAnalysisBuilder.PairClearanceZoneData	getPairClearanceZone(DisplayableObject object1, DisplayableObject object2) Inquire the Clearance Zone for a specific pair of objects.
NXColor	interferenceColor() Returns the color of the interference geometry.
boolean	isCalculatePenetrationDepth() Returns the setting to determine whether penetration depth should be calculated.
boolean	isIgnorePairsWithinSameGroup() Returns the setting to determine whether to ignore pairs within same group.
boolean	isIgnorePairsWithinSamePart() Returns the setting to determine whether to ignore pairs within same part.
boolean	isIgnorePairsWithinSameSubassembly() Returns the setting to determine whether to ignore pairs within same subassembly.
boolean	isIgnorePairsWithinSelectedSubassemblies() Returns the setting to determine whether to ignore pairs within the selected subassemblies.
int	layer() Returns the layer for interference geometry.
boolean	saveInterferenceGeometry() Returns the setting to determine if interference geometry should be saved.
void	setCalculatePenetrationDepth(boolean isCalculatePenetrationDepth) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setCalculationMethod(ClearanceAnalysisBuilder.CalculationMethodType calculateMethod) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setClearanceBetween(ClearanceAnalysisBuilder.ClearanceBetweenEntity clearanceBetweenEntity) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setClearanceSetName(String clearanceSetName) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setCollectionOneRange(ClearanceAnalysisBuilder.CollectionRange collectionRange) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setCollectionTwoRange(ClearanceAnalysisBuilder.CollectionRange collectionRange) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setDefaultClearanceZone(Expression expression) Set the expression as the default Clearance Zone.
void	setIgnorePairsWithinSameGroup(boolean isIgnorePairsWithinSameGroup) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setIgnorePairsWithinSamePart(boolean isIgnorePairsWithinSamePart) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setIgnorePairsWithinSameSubassembly(boolean isIgnorePairsWithinSameSubassembly) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setIgnorePairsWithinSelectedSubassemblies(boolean isIgnorePairsWithinSelectedSubassemblies) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setInterferenceColor(NXColor color) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setLayer(int layer) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setSaveInterferenceGeometry(boolean saveInterferenceGeometry) License requirements: assemblies ("ASSEMBLIES MODULE") .
void	setTotalCollectionCount(ClearanceAnalysisBuilder.NumberOfCollections totalCollectionCount) License requirements: assemblies ("ASSEMBLIES MODULE") .
ClearanceAnalysisBuilder.NumberOfCollections	totalCollectionCount() Returns the setting to determine whether one collection or two collections should be used.
SelectDisplayableObjectList	unitSubassemblies() Returns the selected unit subassemblies.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

clearanceSetName

String clearanceSetName()
                 throws NXException,
                        RemoteException

Returns the clearance set name.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setClearanceSetName

void setClearanceSetName(String clearanceSetName)
                  throws NXException,
                         RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

clearanceSetName -

Throws:

NXException

RemoteException

clearanceBetween

ClearanceAnalysisBuilder.ClearanceBetweenEntity clearanceBetween()
                                                          throws NXException,
                                                                 RemoteException

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
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setClearanceBetween

void setClearanceBetween(ClearanceAnalysisBuilder.ClearanceBetweenEntity clearanceBetweenEntity)
                  throws NXException,
                         RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

clearanceBetweenEntity -

Throws:

NXException

RemoteException

totalCollectionCount

ClearanceAnalysisBuilder.NumberOfCollections totalCollectionCount()
                                                           throws NXException,
                                                                  RemoteException

Returns the setting to determine whether one collection or two collections should be used.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setTotalCollectionCount

void setTotalCollectionCount(ClearanceAnalysisBuilder.NumberOfCollections totalCollectionCount)
                      throws NXException,
                             RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

totalCollectionCount -

Throws:

NXException

RemoteException

collectionOneRange

ClearanceAnalysisBuilder.CollectionRange collectionOneRange()
                                                     throws NXException,
                                                            RemoteException

Returns the range setting for collection one.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCollectionOneRange

void setCollectionOneRange(ClearanceAnalysisBuilder.CollectionRange collectionRange)
                    throws NXException,
                           RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

collectionRange -

Throws:

NXException

RemoteException

collectionOneObjects

SelectDisplayableObjectList collectionOneObjects()
                                          throws NXException,
                                                 RemoteException

Returns the selected objects for collection one.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Throws:

NXException

RemoteException

collectionTwoRange

ClearanceAnalysisBuilder.CollectionRange collectionTwoRange()
                                                     throws NXException,
                                                            RemoteException

Returns the range setting for collection two.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCollectionTwoRange

void setCollectionTwoRange(ClearanceAnalysisBuilder.CollectionRange collectionRange)
                    throws NXException,
                           RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

collectionRange -

Throws:

NXException

RemoteException

collectionTwoObjects

SelectDisplayableObjectList collectionTwoObjects()
                                          throws NXException,
                                                 RemoteException

Returns the selected objects for collection two.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

isIgnorePairsWithinSelectedSubassemblies

boolean isIgnorePairsWithinSelectedSubassemblies()
                                          throws NXException,
                                                 RemoteException

Returns the setting to determine whether to ignore pairs within the selected subassemblies.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setIgnorePairsWithinSelectedSubassemblies

void setIgnorePairsWithinSelectedSubassemblies(boolean isIgnorePairsWithinSelectedSubassemblies)
                                        throws NXException,
                                               RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

isIgnorePairsWithinSelectedSubassemblies -

Throws:

NXException

RemoteException

unitSubassemblies

SelectDisplayableObjectList unitSubassemblies()
                                       throws NXException,
                                              RemoteException

Returns the selected unit subassemblies.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

isIgnorePairsWithinSameSubassembly

boolean isIgnorePairsWithinSameSubassembly()
                                    throws NXException,
                                           RemoteException

Returns the setting to determine whether to ignore pairs within same subassembly.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setIgnorePairsWithinSameSubassembly

void setIgnorePairsWithinSameSubassembly(boolean isIgnorePairsWithinSameSubassembly)
                                  throws NXException,
                                         RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

isIgnorePairsWithinSameSubassembly -

Throws:

NXException

RemoteException

isIgnorePairsWithinSameGroup

boolean isIgnorePairsWithinSameGroup()
                              throws NXException,
                                     RemoteException

Returns the setting to determine whether to ignore pairs within same group.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setIgnorePairsWithinSameGroup

void setIgnorePairsWithinSameGroup(boolean isIgnorePairsWithinSameGroup)
                            throws NXException,
                                   RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

isIgnorePairsWithinSameGroup -

Throws:

NXException

RemoteException

isIgnorePairsWithinSamePart

boolean isIgnorePairsWithinSamePart()
                             throws NXException,
                                    RemoteException

Returns the setting to determine whether to ignore pairs within same part.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setIgnorePairsWithinSamePart

void setIgnorePairsWithinSamePart(boolean isIgnorePairsWithinSamePart)
                           throws NXException,
                                  RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

isIgnorePairsWithinSamePart -

Throws:

NXException

RemoteException

addException

void addException(boolean isExclude,
                  DisplayableObject comp1,
                  DisplayableObject comp2,
                  String text)
           throws NXException,
                  RemoteException

Add an exception.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

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.

Throws:

NXException

RemoteException

deleteException

void deleteException(DisplayableObject comp1,
                     DisplayableObject comp2)
              throws NXException,
                     RemoteException

Delete an exception.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

comp1 - the first object of the pair

comp2 - the second object of the pair

Throws:

NXException

RemoteException

createClearanceZoneExpression

Expression createClearanceZoneExpression(String rhsExpression)
                                  throws NXException,
                                         RemoteException

Create an expression using the Clearance Zone naming convention. The expression is intended for use in the following methods: setDefaultClearanceZone(nxopen.Expression) addPairClearanceZone(nxopen.DisplayableObject, nxopen.DisplayableObject, nxopen.Expression) addObjectClearanceZone(nxopen.DisplayableObject, nxopen.Expression)
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

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

Returns:

the new expression

Throws:

NXException

RemoteException

setDefaultClearanceZone

void setDefaultClearanceZone(Expression expression)
                      throws NXException,
                             RemoteException

Set the expression as the default Clearance Zone. Create the expression using createClearanceZoneExpression(java.lang.String) if the Clearance Zone expression naming convention is desired.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

expression - the expression

Throws:

NXException

RemoteException

getDefaultClearanceZone

Expression getDefaultClearanceZone()
                            throws NXException,
                                   RemoteException

Get the default Clearance Zone expression. If there is no expression set previously, a null will be returned.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Returns:

the expression

Throws:

NXException

RemoteException

addPairClearanceZone

void addPairClearanceZone(DisplayableObject object1,
                          DisplayableObject object2,
                          Expression expression)
                   throws NXException,
                          RemoteException

Add a Clearance Zone between a pair of objects. Create the expression using createClearanceZoneExpression(java.lang.String) if the Clearance Zone expression naming convention is desired.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

object1 - the first object

object2 - the second object

expression - the expression

Throws:

NXException

RemoteException

getPairClearanceZone

ClearanceAnalysisBuilder.PairClearanceZoneData getPairClearanceZone(DisplayableObject object1,
                                                                    DisplayableObject object2)
                                                             throws NXException,
                                                                    RemoteException

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

Created in NX9.0.0

Parameters:

object1 - the first object

object2 - the second object

Returns:

a PairClearanceZoneData object

Throws:

NXException

RemoteException

deletePairClearanceZone

void deletePairClearanceZone(DisplayableObject object1,
                             DisplayableObject object2)
                      throws NXException,
                             RemoteException

Delete an existing Clearance Zone between the given pair of objects.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

object1 - the first object

object2 - the second object

Throws:

NXException

RemoteException

getIsPairIncluded

ClearanceAnalysisBuilder.IsPairIncludedData getIsPairIncluded(DisplayableObject object1,
                                                              DisplayableObject object2)
                                                       throws NXException,
                                                              RemoteException

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

Created in NX9.0.0

Parameters:

object1 - the first object

object2 - the second object

Returns:

a IsPairIncludedData object

Throws:

NXException

RemoteException

addObjectClearanceZone

void addObjectClearanceZone(DisplayableObject object,
                            Expression expression)
                     throws NXException,
                            RemoteException

Add a Clearance Zone around an object. Create the expression using createClearanceZoneExpression(java.lang.String) if the Clearance Zone expression naming convention is desired.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

object - the object

expression - the expression

Throws:

NXException

RemoteException

getObjectClearanceZone

ClearanceAnalysisBuilder.PairClearanceZoneData getObjectClearanceZone(DisplayableObject object)
                                                               throws NXException,
                                                                      RemoteException

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

Created in NX9.0.0

Parameters:

object - the object

Returns:

a PairClearanceZoneData object

Throws:

NXException

RemoteException

deleteObjectClearanceZone

void deleteObjectClearanceZone(DisplayableObject object)
                        throws NXException,
                               RemoteException

Delete an existing Clearance Zone from around an object.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

object - the object

Throws:

NXException

RemoteException

saveInterferenceGeometry

boolean saveInterferenceGeometry()
                          throws NXException,
                                 RemoteException

Returns the setting to determine if interference geometry should be saved.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setSaveInterferenceGeometry

void setSaveInterferenceGeometry(boolean saveInterferenceGeometry)
                          throws NXException,
                                 RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

saveInterferenceGeometry -

Throws:

NXException

RemoteException

layer

int layer()
   throws NXException,
          RemoteException

Returns the layer for interference geometry.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setLayer

void setLayer(int layer)
       throws NXException,
              RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

layer -

Throws:

NXException

RemoteException

interferenceColor

NXColor interferenceColor()
                   throws NXException,
                          RemoteException

Returns the color of the interference geometry.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setInterferenceColor

void setInterferenceColor(NXColor color)
                   throws NXException,
                          RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

color -

Throws:

NXException

RemoteException

calculationMethod

ClearanceAnalysisBuilder.CalculationMethodType calculationMethod()
                                                          throws NXException,
                                                                 RemoteException

Returns the setting for the clearance calculation method.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCalculationMethod

void setCalculationMethod(ClearanceAnalysisBuilder.CalculationMethodType calculateMethod)
                   throws NXException,
                          RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

calculateMethod -

Throws:

NXException

RemoteException

isCalculatePenetrationDepth

boolean isCalculatePenetrationDepth()
                             throws NXException,
                                    RemoteException

Returns the setting to determine whether penetration depth should be calculated.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCalculatePenetrationDepth

void setCalculatePenetrationDepth(boolean isCalculatePenetrationDepth)
                           throws NXException,
                                  RemoteException

License requirements: assemblies ("ASSEMBLIES MODULE")
.
Created in NX9.0.0

Parameters:

isCalculatePenetrationDepth -

Throws:

NXException

RemoteException