public interface ClearanceAnalysisBuilder extends Builder
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.
AssemblyManager.createClearanceAnalysisBuilder(nxopen.assemblies.ClearanceSet)
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.
|
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.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
String clearanceSetName() throws NXException, RemoteException
NXException
RemoteException
void setClearanceSetName(String clearanceSetName) throws NXException, RemoteException
clearanceSetName
- NXException
RemoteException
ClearanceAnalysisBuilder.ClearanceBetweenEntity clearanceBetween() throws NXException, RemoteException
NXException
RemoteException
void setClearanceBetween(ClearanceAnalysisBuilder.ClearanceBetweenEntity clearanceBetweenEntity) throws NXException, RemoteException
clearanceBetweenEntity
- NXException
RemoteException
ClearanceAnalysisBuilder.NumberOfCollections totalCollectionCount() throws NXException, RemoteException
NXException
RemoteException
void setTotalCollectionCount(ClearanceAnalysisBuilder.NumberOfCollections totalCollectionCount) throws NXException, RemoteException
totalCollectionCount
- NXException
RemoteException
ClearanceAnalysisBuilder.CollectionRange collectionOneRange() throws NXException, RemoteException
NXException
RemoteException
void setCollectionOneRange(ClearanceAnalysisBuilder.CollectionRange collectionRange) throws NXException, RemoteException
collectionRange
- NXException
RemoteException
SelectDisplayableObjectList collectionOneObjects() throws NXException, RemoteException
NXException
RemoteException
ClearanceAnalysisBuilder.CollectionRange collectionTwoRange() throws NXException, RemoteException
NXException
RemoteException
void setCollectionTwoRange(ClearanceAnalysisBuilder.CollectionRange collectionRange) throws NXException, RemoteException
collectionRange
- NXException
RemoteException
SelectDisplayableObjectList collectionTwoObjects() throws NXException, RemoteException
NXException
RemoteException
boolean isIgnorePairsWithinSelectedSubassemblies() throws NXException, RemoteException
NXException
RemoteException
void setIgnorePairsWithinSelectedSubassemblies(boolean isIgnorePairsWithinSelectedSubassemblies) throws NXException, RemoteException
isIgnorePairsWithinSelectedSubassemblies
- NXException
RemoteException
SelectDisplayableObjectList unitSubassemblies() throws NXException, RemoteException
NXException
RemoteException
boolean isIgnorePairsWithinSameSubassembly() throws NXException, RemoteException
NXException
RemoteException
void setIgnorePairsWithinSameSubassembly(boolean isIgnorePairsWithinSameSubassembly) throws NXException, RemoteException
isIgnorePairsWithinSameSubassembly
- NXException
RemoteException
boolean isIgnorePairsWithinSameGroup() throws NXException, RemoteException
NXException
RemoteException
void setIgnorePairsWithinSameGroup(boolean isIgnorePairsWithinSameGroup) throws NXException, RemoteException
isIgnorePairsWithinSameGroup
- NXException
RemoteException
boolean isIgnorePairsWithinSamePart() throws NXException, RemoteException
NXException
RemoteException
void setIgnorePairsWithinSamePart(boolean isIgnorePairsWithinSamePart) throws NXException, RemoteException
isIgnorePairsWithinSamePart
- NXException
RemoteException
void addException(boolean isExclude, DisplayableObject comp1, DisplayableObject comp2, String text) throws NXException, RemoteException
isExclude
- exclude or include type of the exceptioncomp1
- the first object of the paircomp2
- the second object of the pairtext
- note for the exceptionNXException
RemoteException
void deleteException(DisplayableObject comp1, DisplayableObject comp2) throws NXException, RemoteException
comp1
- the first object of the paircomp2
- the second object of the pairNXException
RemoteException
Expression createClearanceZoneExpression(String rhsExpression) throws NXException, RemoteException
setDefaultClearanceZone(nxopen.Expression)
addPairClearanceZone(nxopen.DisplayableObject, nxopen.DisplayableObject, nxopen.Expression)
addObjectClearanceZone(nxopen.DisplayableObject, nxopen.Expression)
rhsExpression
- the text for the expressionNXException
RemoteException
void setDefaultClearanceZone(Expression expression) throws NXException, RemoteException
createClearanceZoneExpression(java.lang.String)
if the Clearance Zone expression naming convention is desired.
expression
- the expressionNXException
RemoteException
Expression getDefaultClearanceZone() throws NXException, RemoteException
NXException
RemoteException
void addPairClearanceZone(DisplayableObject object1, DisplayableObject object2, Expression expression) throws NXException, RemoteException
createClearanceZoneExpression(java.lang.String)
if the Clearance Zone expression naming convention is desired.
object1
- the first objectobject2
- the second objectexpression
- the expressionNXException
RemoteException
ClearanceAnalysisBuilder.PairClearanceZoneData getPairClearanceZone(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
ClearanceAnalysisBuilder.ClearanceZoneSource.OBJECT1
or ClearanceAnalysisBuilder.ClearanceZoneSource.OBJECT2
.
ClearanceAnalysisBuilder.ClearanceZoneSource.PAIR
means this pair has its own explicit clearance zone.
ClearanceAnalysisBuilder.ClearanceZoneSource.DEFAULT
means the default clearance zone is used..
object1
- the first objectobject2
- the second objectNXException
RemoteException
void deletePairClearanceZone(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
object1
- the first objectobject2
- the second objectNXException
RemoteException
ClearanceAnalysisBuilder.IsPairIncludedData getIsPairIncluded(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
ClearanceAnalysisBuilder.PairExcludedReason.USER_DEFINED
reason.
object1
- the first objectobject2
- the second objectNXException
RemoteException
void addObjectClearanceZone(DisplayableObject object, Expression expression) throws NXException, RemoteException
createClearanceZoneExpression(java.lang.String)
if the Clearance Zone expression naming convention is desired.
object
- the objectexpression
- the expressionNXException
RemoteException
ClearanceAnalysisBuilder.PairClearanceZoneData getObjectClearanceZone(DisplayableObject object) throws NXException, RemoteException
ClearanceAnalysisBuilder.ClearanceZoneSource.DEFINED
specifies
that the object has its own Clearance Zone.
ClearanceAnalysisBuilder.ClearanceZoneSource.DEFAULT
means the
default clearance zone is used.
object
- the objectNXException
RemoteException
void deleteObjectClearanceZone(DisplayableObject object) throws NXException, RemoteException
object
- the objectNXException
RemoteException
boolean saveInterferenceGeometry() throws NXException, RemoteException
NXException
RemoteException
void setSaveInterferenceGeometry(boolean saveInterferenceGeometry) throws NXException, RemoteException
saveInterferenceGeometry
- NXException
RemoteException
int layer() throws NXException, RemoteException
NXException
RemoteException
void setLayer(int layer) throws NXException, RemoteException
layer
- NXException
RemoteException
NXColor interferenceColor() throws NXException, RemoteException
NXException
RemoteException
void setInterferenceColor(NXColor color) throws NXException, RemoteException
color
- NXException
RemoteException
ClearanceAnalysisBuilder.CalculationMethodType calculationMethod() throws NXException, RemoteException
NXException
RemoteException
void setCalculationMethod(ClearanceAnalysisBuilder.CalculationMethodType calculateMethod) throws NXException, RemoteException
calculateMethod
- NXException
RemoteException
boolean isCalculatePenetrationDepth() throws NXException, RemoteException
NXException
RemoteException
void setCalculatePenetrationDepth(boolean isCalculatePenetrationDepth) throws NXException, RemoteException
isCalculatePenetrationDepth
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.