ReferenceSet Class¶
-
class
NXOpen.
ReferenceSet
¶ Bases:
NXOpen.DisplayableObject
Represents a
NXOpen.ReferenceSet
This is no KF creation
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Color | Returns or sets the color of the object. |
IsBlanked | Returns the blank status of this object. |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Layer | Returns or sets the layer that the object is in. |
LineFont | Returns or sets the line font of the object. |
LineWidth | Returns or sets the line width of the object. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddObjectsToReferenceSet | Addition of objects to reference set |
AskAllDirectMembers | Query of reference set members. |
AskMembersInReferenceSet | Query of reference set members. |
Blank | Blanks the object. |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAddComponentsAutomatically | Returns the add components automatically toggle value. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, of the given type. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | 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. |
Highlight | Highlights the object. |
Prints a representation of this object to the system log file. | |
RedisplayObject | Redisplays the object in all views. |
RemoveObjectsFromReferenceSet | Removal of objects from reference set |
RemoveViewDependency | Remove dependency on all views from an object. |
SetAddComponentsAutomatically | Sets the add components automatically toggle value. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetName | Sets the custom name of the object. |
SetNameLocation | Sets the location of the object’s name. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
Unblank | Unblanks the object. |
Unhighlight | Unhighlights the object. |
Property Detail¶
IsOccurrence¶
-
ReferenceSet.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence()
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
ReferenceSet.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
ReferenceSet.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
ReferenceSet.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent()
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
ReferenceSet.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart()
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
Prototype¶
-
ReferenceSet.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype()
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Method Detail¶
AddObjectsToReferenceSet¶
-
ReferenceSet.
AddObjectsToReferenceSet
¶ Addition of objects to reference set
Signature
AddObjectsToReferenceSet(components)
Parameters: components (list of NXOpen.NXObject
) – Array of the selected objects to be added in the refernce setNew in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
AskAllDirectMembers¶
-
ReferenceSet.
AskAllDirectMembers
¶ Query of reference set members.
Includes solid bodies, facet bodies, miscellaneous entities other than solid and facet bodies and assembly components.
Signature
AskAllDirectMembers()
Returns: Members of reference set Return type: list of NXOpen.NXObject
New in version NX7.5.0.
License requirements: None.
AskMembersInReferenceSet¶
-
ReferenceSet.
AskMembersInReferenceSet
¶ Query of reference set members.
Includes solid bodies, facet bodies and miscellaneous entities other than solid and facet bodies. Also includes entity objects like faces and edges. Does not include assembly components. This method may return some members which are not visible given the current feature state, but which would become visible if a different feature was made current. Use
NXOpen.ReferenceSet.AskAllDirectMembers
instead to avoid such members if desired.Signature
AskMembersInReferenceSet()
Returns: Members of reference set Return type: list of NXOpen.NXObject
New in version NX6.0.0.
License requirements: None.
FindObject¶
-
ReferenceSet.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
GetAddComponentsAutomatically¶
-
ReferenceSet.
GetAddComponentsAutomatically
¶ Returns the add components automatically toggle value.
This controls whether new components added to the part will automatically get added to this reference set.
Signature
GetAddComponentsAutomatically()
Returns: The current setting for the add components automatically property Return type: bool New in version NX6.0.0.
License requirements: None.
Print¶
-
ReferenceSet.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveObjectsFromReferenceSet¶
-
ReferenceSet.
RemoveObjectsFromReferenceSet
¶ Removal of objects from reference set
Signature
RemoveObjectsFromReferenceSet(components)
Parameters: components (list of NXOpen.NXObject
) – Array of the selected objects to be removed from the refernce setNew in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetAddComponentsAutomatically¶
-
ReferenceSet.
SetAddComponentsAutomatically
¶ Sets the add components automatically toggle value.
This controls whether new components added to the part will automatically get added to this reference set.
Signature
SetAddComponentsAutomatically(newValue, addExistingComponents)
Parameters: - newValue (bool) – The new setting for the add components automatically property
- addExistingComponents (bool) – Specifies whether existing components should be added to the reference set, and only applies when newValue is true
New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetName¶
-
ReferenceSet.
SetName
¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)
Parameters: name (str) – New in version NX3.0.0.
License requirements: None.