public interface ClearanceSet extends NXObject
ClearanceSet
. Input to this class can be PSM facet objects.
Modifier and Type | Interface and Description |
---|---|
static class |
ClearanceSet.CopyMode
Specify the dataset copy mode
|
static class |
ClearanceSet.InterferenceData
This class holds the data returned from
getInterferenceData(nxopen.DisplayableObject, nxopen.DisplayableObject) |
static class |
ClearanceSet.InterferenceType
Specify the type of interference
|
static class |
ClearanceSet.JobStatus
Specify the job aborted status
|
static class |
ClearanceSet.NextInterferenceData
This class holds the data returned from
getNextInterference(nxopen.DisplayableObject, nxopen.DisplayableObject) |
static class |
ClearanceSet.PenetrationDepthResult
The result of penetration depth calculation
|
static class |
ClearanceSet.ReanalyzeOutOfDateExcludedPairs
Specify whether to reanalyze out-of-date excluded pairs.
|
static class |
ClearanceSet.ReanalyzePairCalculationMethod
The analysis method to use when reanalyzing a pair.
|
static class |
ClearanceSet.Summary
Summary of the most recent Clearance Analysis results
|
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
void |
calculatePenetrationDepth(DisplayableObject[] firstObjects,
DisplayableObject[] secondObjects)
Calculate penetration depth for a set of hard interferences.
|
ClearanceSet |
copy(String name,
ClearanceSet.CopyMode mode)
Makes a copy of a dataset.
|
void |
createInterferenceGeometry(DisplayableObject[] firstObjects,
DisplayableObject[] secondObjects)
Construct interference geometry for a set of hard interferences.
|
void |
delete()
Delete this clearance set
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
deleteInterference(DisplayableObject object1,
DisplayableObject object2)
Deletes the interference for a given object pair.
|
boolean |
detectObsoleteSettings(boolean doCleanupNow)
Detects whether a clearance set was defined with settings which are obsolete/no longer supported.
|
ClearanceSet.InterferenceData |
getInterferenceData(DisplayableObject object1,
DisplayableObject object2)
Inquires the data associated with a given pair of interfering objects.
|
boolean |
getIsPairChanged(DisplayableObject object1,
DisplayableObject object2)
Inquires if an object pair has changed since the last analysis run.
|
ClearanceSet.NextInterferenceData |
getNextInterference(DisplayableObject object1,
DisplayableObject object2)
Cycles the interference in a clearance analysis data set.
|
int |
getNumberOfInterferences()
Inquires the number of interferences stored in a clearance analysis
data set.
|
ClearanceSet.Summary |
getResults()
Inquires a summary of the results of the most recent clearance analysis run.
|
int |
getVersion()
Gets the version of a clearance analysis dataset.
|
void |
performAnalysis(ClearanceSet.ReanalyzeOutOfDateExcludedPairs reanalyzeOption)
Perform an analysis on this clearance set with option to specify whether
out-of-date excluded pairs will be reanalyzed.
|
void |
reanalyzePairs(DisplayableObject[] firstObjects,
DisplayableObject[] secondObjects,
ClearanceSet.ReanalyzePairCalculationMethod calculationMethod)
Reanalyze a set of interferences using the specified analysis method.
|
void |
setInterferenceText(DisplayableObject object1,
DisplayableObject object2,
String text)
Associates a text string to an interfering object pair.
|
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
void performAnalysis(ClearanceSet.ReanalyzeOutOfDateExcludedPairs reanalyzeOption) throws NXException, RemoteException
reanalyzeOption
- NXException
RemoteException
void reanalyzePairs(DisplayableObject[] firstObjects, DisplayableObject[] secondObjects, ClearanceSet.ReanalyzePairCalculationMethod calculationMethod) throws NXException, RemoteException
firstObjects
- The first object of each interference. Must be the same size as secondObjects.secondObjects
- The second object of each interference. Must be the same size as firstObjects.calculationMethod
- NXException
RemoteException
void createInterferenceGeometry(DisplayableObject[] firstObjects, DisplayableObject[] secondObjects) throws NXException, RemoteException
firstObjects
- The first object of each interference. Must be the same size as secondObjects.secondObjects
- The second object of each interference. Must be the same size as firstObjects.NXException
RemoteException
void calculatePenetrationDepth(DisplayableObject[] firstObjects, DisplayableObject[] secondObjects) throws NXException, RemoteException
firstObjects
- The first object of each interference. Must be the same size as secondObjects.secondObjects
- The second object of each interference. Must be the same size as firstObjects.NXException
RemoteException
void delete() throws NXException, RemoteException
NXException
RemoteException
int getVersion() throws NXException, RemoteException
NXException
RemoteException
ClearanceSet.InterferenceData getInterferenceData(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
object1
- the first object in the pairobject2
- the second object in the pairNXException
RemoteException
ClearanceSet.Summary getResults() throws NXException, RemoteException
ClearanceSet.Summary
structure is
filled with analysis statistics, including numbers of objects, number of pairs,
number of checked pairs, and number of interferences of each type. If
clearance analysis has never been run on the data set, an error is
returned.
NXException
RemoteException
int getNumberOfInterferences() throws NXException, RemoteException
NXException
RemoteException
void deleteInterference(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
object1
- the first object in the pairobject2
- the second object in the pairNXException
RemoteException
boolean getIsPairChanged(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
object1
- the first object in the pairobject2
- the second object in the pairNXException
RemoteException
ClearanceSet.NextInterferenceData getNextInterference(DisplayableObject object1, DisplayableObject object2) throws NXException, RemoteException
object1
- the first object in the pair of the current interferenceobject2
- the second object in the pair of the current interferenceNXException
RemoteException
ClearanceSet copy(String name, ClearanceSet.CopyMode mode) throws NXException, RemoteException
ClearanceSet.CopyMode.NO_RESULTS
only copies the setup data. The version of the new dataset is set to zero (meaning clearance analysis
has not been run); ClearanceSet.CopyMode.RESULTS
makes a copy of the current
analysis results, but not the interference bodies; ClearanceSet.CopyMode.INTERF_BODIES
makes a complete copy of the results. The name must be less than MAX_LINE_SIZE characters long
name
- the name of the new datasetmode
- copy modeNXException
RemoteException
void setInterferenceText(DisplayableObject object1, DisplayableObject object2, String text) throws NXException, RemoteException
object1
- the first object in the pairobject2
- the second object in the pairtext
- the name of the new datasetNXException
RemoteException
boolean detectObsoleteSettings(boolean doCleanupNow) throws NXException, RemoteException
doCleanupNow
- whether cleanup should be performed nowNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.