|
NXOpen .NET Reference Guide
1899
|
|
NXOpen .NET Reference Guide
1899
|
Represents NXOpen.Assemblies.ClearanceSet . More...
Classes | |
| struct | Summary |
| Summary of the most recent Clearance Analysis results More... | |
Public Types | |
| enum | CopyMode { NoResults, Results, InterfBodies } |
| Specify the dataset copy mode More... | |
| enum | InterferenceStatus { Undetermined, Resolved, Irrelevant, Pending } |
| Specify the status of the interference More... | |
| enum | InterferenceType { Soft, Touch, Hard, Cont1In2, Cont2In1, NoInterference } |
| Specify the type of interference More... | |
| enum | JobStatus { NotAborted, AbortedByUser, AbortedOnError } |
| Specify the job aborted status More... | |
| enum | PenetrationDepthResult { NotAttempted, Success, NoClash, Touching, BothSheets, UnspecifiedError } |
| The result of penetration depth calculation More... | |
| enum | ReanalyzeOutOfDateExcludedPairs { CustomerDefault, True, False } |
| Specify whether to reanalyze out-of-date excluded pairs. More... | |
| enum | ReanalyzePairCalculationMethod { UseStoredMethod, Lightweight, ExactIfLoaded, Exact } |
| The analysis method to use when reanalyzing a pair. More... | |
 Public Types inherited from NXOpen.NXObject | |
| enum | AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 } |
| Specifies attribute type. More... | |
| enum | DateAndTimeFormat { Numeric, Textual } |
| Specifies the format of the date and time attribute. More... | |
Public Member Functions | |
| unsafe void | CalculatePenetrationDepth (NXOpen.DisplayableObject[] firstObjects, NXOpen.DisplayableObject[] secondObjects) |
| Calculate penetration depth for a set of hard interferences. More... | |
| unsafe NXOpen.Assemblies.ClearanceSet | Copy (string name, NXOpen.Assemblies.ClearanceSet.CopyMode mode) |
| Makes a copy of a dataset. More... | |
| unsafe void | CreateInterferenceGeometry (NXOpen.DisplayableObject[] firstObjects, NXOpen.DisplayableObject[] secondObjects) |
| Construct interference geometry for a set of hard interferences. More... | |
| unsafe void | Delete () |
| Delete this clearance set More... | |
| unsafe void | DeleteAllInterferences () |
| Deletes all interference results stored in this clearance set. More... | |
| unsafe void | DeleteInterference (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2) |
| Deletes the interference for a given object pair. More... | |
| unsafe bool | DetectObsoleteSettings (bool doCleanupNow) |
| Detects whether a clearance set was defined with settings which are obsolete/no longer supported. More... | |
| unsafe void | GetInterferenceData (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2, out NXOpen.Assemblies.ClearanceSet.InterferenceType type, out bool newInterference, out NXOpen.DisplayableObject[] interfBodies, out NXOpen.Point3d point1, out NXOpen.Point3d point2, out string text, out int interfNum, out int config, out int depthResult, out double depth, out NXOpen.Vector3d direction, out NXOpen.Point3d minPoint, out NXOpen.Point3d maxPoint) |
| Inquires the data associated with a given pair of interfering objects. More... | |
| unsafe NXOpen.Assemblies.ClearanceSet.InterferenceStatus | GetInterferenceStatus (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2) |
| Inquires the status associated with a given pair of interfering objects. More... | |
| unsafe bool | GetIsPairChanged (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2) |
| Inquires if an object pair has changed since the last analysis run. More... | |
| unsafe void | GetNextInterference (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2, out NXOpen.DisplayableObject nextObject1, out NXOpen.DisplayableObject nextObject2) |
| Cycles the interference in a clearance analysis data set. More... | |
| unsafe int | GetNumberOfInterferences () |
| Inquires the number of interferences stored in a clearance analysis data set. More... | |
| unsafe NXOpen.Assemblies.ClearanceSet.Summary | GetResults () |
| Inquires a summary of the results of the most recent clearance analysis run. More... | |
| unsafe int | GetVersion () |
| Gets the version of a clearance analysis dataset. More... | |
| unsafe void | PerformAnalysis (NXOpen.Assemblies.ClearanceSet.ReanalyzeOutOfDateExcludedPairs reanalyzeOption) |
| Perform an analysis on this clearance set with option to specify whether out-of-date excluded pairs will be reanalyzed. More... | |
| unsafe void | ReanalyzePairs (NXOpen.DisplayableObject[] firstObjects, NXOpen.DisplayableObject[] secondObjects, NXOpen.Assemblies.ClearanceSet.ReanalyzePairCalculationMethod calculationMethod) |
| Reanalyze a set of interferences using the specified analysis method. More... | |
| unsafe void | SetInterferenceStatus (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2, NXOpen.Assemblies.ClearanceSet.InterferenceStatus status) |
| Set the status associated with a given pair of interfering objects. More... | |
| unsafe void | SetInterferenceText (NXOpen.DisplayableObject object1, NXOpen.DisplayableObject object2, string text) |
| Associates a text string to an interfering object pair. More... | |
| Public Member Functions inherited from NXOpen.NXObject | |
| unsafe NXOpen.AttributeIterator | CreateAttributeIterator () |
| Create an attribute iterator More... | |
| unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type) |
| Deletes all attributes of a specific type. More... | |
| unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
| Deletes all attributes of a specific type with the option to update or not. More... | |
| unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title) |
| Deletes an attribute by type and title. More... | |
| unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option) |
| Deletes an attribute by type and title with the option to update or not. More... | |
| unsafe void | DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option) |
| Deletes the first attribute encountered with the given Type, Title. More... | |
| unsafe void | DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option) |
| Deletes the attributes on the object, if any, that satisfy the given iterator More... | |
| unsafe void | DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
| Deletes the attributes encountered with the given Type with option to update or not. More... | |
| unsafe NXOpen.INXObject | FindObject (string journalIdentifier) |
| Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
| unsafe NXOpen.NXObject.AttributeInformation[] | GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type) |
| Gets all the attribute titles of a specific type. More... | |
| unsafe bool | GetBooleanUserAttribute (string title, int index) |
| Gets a boolean attribute by Title and array Index. More... | |
| unsafe NXOpen.NXObject.ComputationalTime | GetComputationalTimeUserAttribute (string title, int index) |
| Gets a time attribute by Title and array Index. More... | |
| unsafe int | GetIntegerAttribute (string title) |
| Gets an integer attribute by title. More... | |
| unsafe int | GetIntegerUserAttribute (string title, int index) |
| Gets an integer attribute by Title and array Index. More... | |
| unsafe bool | GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info) |
| Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More... | |
| unsafe string | GetPdmReferenceAttributeValue (string attributeTitle) |
| Gets the value of PDM Reference attribute for given object. More... | |
| unsafe double | GetRealAttribute (string title) |
| Gets a real attribute by title. More... | |
| unsafe double | GetRealUserAttribute (string title, int index) |
| Gets a real attribute by Title and array Index. More... | |
| unsafe string | GetReferenceAttribute (string title) |
| Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
| unsafe string | GetStringAttribute (string title) |
| Gets a string attribute value by title. More... | |
| unsafe string | GetStringUserAttribute (string title, int index) |
| Gets a string attribute by Title and array Index. More... | |
| unsafe string | GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title) |
| Gets a time attribute by title. More... | |
| unsafe string | GetTimeUserAttribute (string title, int index) |
| Gets a time attribute by Title and array Index. More... | |
| unsafe NXOpen.NXObject.AttributeInformation | GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
| Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
| unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type) |
| Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
| unsafe string | GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index) |
| Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
| unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator) |
| Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
| unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute) |
| Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
| unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type) |
| Gets the count of set attributes on the object, if any, of the given type. More... | |
| unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute) |
| Gets the count of attributes on the object, if any, of the given type. More... | |
| unsafe bool | GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type) |
| Determine the lock of the given attribute. More... | |
| unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (NXOpen.AttributeIterator iterator) |
| Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More... | |
| unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes () |
| Gets all the attributes that have been set on the given object. More... | |
| unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset) |
| Gets all the attributes of the given object. More... | |
| unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset, bool addStringValues) |
| Gets all the attributes of the given object. More... | |
| unsafe string[] | GetUserAttributesAsStrings () |
| Gets all the attributes that have been set on the given object. More... | |
| unsafe int | GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type) |
| Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
| unsafe NXOpen.NXObject[] | GetUserAttributeSourceObjects () |
| Returns an array of objects from which this object presents attributes. More... | |
| unsafe bool | HasUserAttribute (NXOpen.AttributeIterator iterator) |
| Determines if an attribute exists on the object, that satisfies the given iterator More... | |
| unsafe bool | HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
| Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
| unsafe void | Print () |
| Prints a representation of this object to the system log file. More... | |
| unsafe void | SetAttribute (string title, int value) |
| Creates or modifies an integer attribute. More... | |
| unsafe void | SetAttribute (string title, int value, NXOpen.Update.Option option) |
| Creates or modifies an integer attribute with the option to update or not. More... | |
| unsafe void | SetAttribute (string title, double value) |
| Creates or modifies a real attribute. More... | |
| unsafe void | SetAttribute (string title, double value, NXOpen.Update.Option option) |
| Creates or modifies a real attribute with the option to update or not. More... | |
| unsafe void | SetAttribute (string title, string value) |
| Creates or modifies a string attribute. More... | |
| unsafe void | SetAttribute (string title, string value, NXOpen.Update.Option option) |
| Creates or modifies a string attribute with the option to update or not. More... | |
| unsafe void | SetAttribute (string title) |
| Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
| unsafe void | SetAttribute (string title, NXOpen.Update.Option option) |
| Creates or modifies a null attribute with the option to update or not. More... | |
| unsafe void | SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option) |
| Creates or modifies a boolean attribute with the option to update or not. More... | |
| unsafe void | SetName (string name) |
| Sets the custom name of the object. More... | |
| unsafe void | SetPdmReferenceAttribute (string attributeTitle, string attributeValue) |
| Sets the value of PDM Reference attribute on the object. More... | |
| unsafe void | SetReferenceAttribute (string title, string value) |
| Creates or modifies a string attribute which uses a reference string. More... | |
| unsafe void | SetReferenceAttribute (string title, string value, NXOpen.Update.Option option) |
| Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
| unsafe void | SetTimeAttribute (string title, string value) |
| Creates or modifies a time attribute. More... | |
| unsafe void | SetTimeAttribute (string title, string value, NXOpen.Update.Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| unsafe void | SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| unsafe void | SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| unsafe void | SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option) |
| Creates or modifies an attribute with the option to update or not. More... | |
| unsafe void | SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option) |
| Creates or modifies an integer attribute with the option to update or not. More... | |
| unsafe void | SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option) |
| Creates or modifies a real attribute with the option to update or not. More... | |
| unsafe void | SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
| Creates or modifies a string attribute with the option to update or not. More... | |
| unsafe void | SetUserAttribute (string title, int index, NXOpen.Update.Option option) |
| Creates or modifies a null attribute with the option to update or not. More... | |
| unsafe void | SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock) |
| Lock or unlock the given attribute. 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from NXOpen.TaggedObject | |
| new void | initialize () |
| <exclude> More... | |
| Properties inherited from NXOpen.NXObject | |
| unsafe bool | IsOccurrence [get] |
| Returns whether this object is an occurrence or not. More... | |
| unsafe string | JournalIdentifier [get] |
| Returns the identifier that would be recorded in a journal for this object. More... | |
| unsafe string | Name [get] |
| Returns the custom name of the object. More... | |
| unsafe NXOpen.Assemblies.Component | OwningComponent [get] |
| Returns the owning component, if this object is an occurrence. More... | |
| unsafe NXOpen.BasePart | OwningPart [get] |
| Returns the owning part of this object More... | |
| unsafe NXOpen.INXObject | Prototype [get] |
| Returns the prototype of this object if it is an occurrence. More... | |
Represents NXOpen.Assemblies.ClearanceSet .
Input to this class can be PSM facet objects.
Currently we don't support KF at this time.
Created in NX9.0.0
|
inline |
Calculate penetration depth for a set of hard interferences.
The interferences must be specified using two parallel arrays: the objects in the first interference should be given in the first elements of the arrays, the objects in the second interference should be given in the second elements of the arrays, etc.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| 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. |
|
inline |
Makes a copy of a dataset.
You must supply a unique name. There are three modes in which to copy the dataset: NXOpen.Assemblies.ClearanceSet.CopyMode.NoResults only copies the setup data. The version of the new dataset is set to zero (meaning clearance analysis has not been run); NXOpen.Assemblies.ClearanceSet.CopyMode.Results makes a copy of the current analysis results, but not the interference bodies; NXOpen.Assemblies.ClearanceSet.CopyMode.InterfBodies makes a complete copy of the results. The name must be less than MAX_LINE_SIZE characters long
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| name | the name of the new dataset |
| mode | copy mode |
|
inline |
Construct interference geometry for a set of hard interferences.
The interferences must be specified using two parallel arrays: the objects in the first interference should be given in the first elements of the arrays, the objects in the second interference should be given in the second elements of the arrays, etc.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| 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. |
|
inline |
Delete this clearance set
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
|
inline |
Deletes all interference results stored in this clearance set.
Created in NX12.0.2
License requirements: assemblies ("ASSEMBLIES MODULE")
|
inline |
Deletes the interference for a given object pair.
Both objects must be members of the given data set. If the object pair does not refer to an existing interference, an error is returned. All data associated with the interference is deleted.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair |
| object2 | the second object in the pair |
|
inline |
Detects whether a clearance set was defined with settings which are obsolete/no longer supported.
For example, prior to NX 9.0, an optional setting "ignore mated pairs" was available. Existing results may still be read from a clearance set with obsolete settings, but the next time analysis is performed, the obsolete settings will be removed and all existing results cleared. Optionally, this method can perform any required cleanup now, instead of waiting until the next analysis.
Created in NX10.0.2
License requirements: assemblies ("ASSEMBLIES MODULE")
| doCleanupNow | whether cleanup should be performed now |
|
inline |
Inquires the data associated with a given pair of interfering objects.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair |
| object2 | the second object in the pair |
| type | the interference type |
| newInterference | the flag for new interference |
| interfBodies | the list of interference bodies |
| point1 | a point on the first object |
| point2 | a point on the second object |
| text | text associated with the interference |
| interfNum | a unique number for the interference |
| config | the configuration index |
| depthResult | result status of penetration depth calculation |
| depth | depth of penetration |
| direction | a unit vector indicating the direction of penetration |
| minPoint | the points on the interference region at the extremes of depth |
| maxPoint | the points on the interference region at the extremes of depth |
|
inline |
Inquires the status associated with a given pair of interfering objects.
The status is only retrieved if an interference exists between the two objects.
Created in NX12.0.2
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair |
| object2 | the second object in the pair |
|
inline |
Inquires if an object pair has changed since the last analysis run.
Both objects must be solid bodies or facet models that are members of the clearance analysis data set. If either object has changed since the last analysis run, then isChanged is returned as TRUE. If no analysis has been run on either of the objects, TRUE is returned.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair |
| object2 | the second object in the pair |
|
inline |
Cycles the interference in a clearance analysis data set.
Interferences are stored as object pairs. Start the cycling using a null reference (Nothing in Visual Basic) as the input values for both object1 and object2. This routine passes back the tags of the objects that define the next interference. a null reference (Nothing in Visual Basic) returned for either object indicates the end of the cycling.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair of the current interference |
| object2 | the second object in the pair of the current interference |
| nextObject1 | the first object in the pair of the next interference |
| nextObject2 | the second object in the pair of the next interference |
|
inline |
Inquires the number of interferences stored in a clearance analysis data set.
If clearance analysis has never been run on the data set, an error is returned.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
|
inline |
Inquires a summary of the results of the most recent clearance analysis run.
The NXOpen.Assemblies.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.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
|
inline |
Gets the version of a clearance analysis dataset.
The version indicates how many times clearance analysis has been run on a data set. If the version is zero, then the analysis has never been run.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
|
inline |
Perform an analysis on this clearance set with option to specify whether out-of-date excluded pairs will be reanalyzed.
You can specify to use the Customer Default setting, or you can specify a true or false option to override the Customer Default.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| reanalyzeOption |
|
inline |
Reanalyze a set of interferences using the specified analysis method.
The interferences must be specified using two parallel arrays: the objects in the first interference should be given in the first elements of the arrays, the objects in the second interference should be given in the second elements of the arrays, etc.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| 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 |
|
inline |
Set the status associated with a given pair of interfering objects.
The status is only filled if an interference exists between the two objects.
Created in NX12.0.2
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair |
| object2 | the second object in the pair |
| status | the new status of the interference |
|
inline |
Associates a text string to an interfering object pair.
Both objects must be members of the given dataset. If the object pair does not refer to an existing interference, an error is returned.
Created in NX9.0.0
License requirements: assemblies ("ASSEMBLIES MODULE")
| object1 | the first object in the pair |
| object2 | the second object in the pair |
| text | the name of the new dataset |
