Arrangement Class¶
-
class
NXOpen.Assemblies.Arrangement¶ Bases:
NXOpen.NXObjectManages the suppression of
NXOpen.Assemblies.Component`s within a :py:class:`NXOpen.Assemblies.ComponentAssembly.Currently, an Arrangement simply acts as a context within which a Component can be suppressed, unsuppressed, or positioned.
To create an
NXOpen.Assemblies.Arrangement, use theNXOpen.Assemblies.ArrangementCollectionclass.An isolated
NXOpen.Assemblies.Arrangementis anNXOpen.Assemblies.Arrangementthat is capable of supporting isolated positions and isolated position overrides.A standard
NXOpen.Assemblies.Arrangementis anNXOpen.Assemblies.Arrangementthat does not support isolated position or isolated position overrides. All :py:class:`NXOpen.Assemblies.Arrangement`s created in NX 8.5 or earlier are standard :py:class:`NXOpen.Assemblies.Arrangement`s.New in version NX3.0.0.
Properties¶
| Property | Description |
|---|---|
| IgnoringConstraints | Returns or sets the flag indicating whether this NXOpen.Assemblies.Arrangement is ignoring constraints. |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Name | Returns the custom name of the object. |
| Owner | Returns the NXOpen.Assemblies.ComponentAssembly which owns this arrangement |
| 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 |
|---|---|
| Delete | Delete the given NXOpen.Assemblies.Arrangement. |
| 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. |
| 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. |
| GetHasPostponedConstraints | Get whether this NXOpen.Assemblies.Arrangement has postponed its solve. |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetMaintainsConstraints | Get whether this NXOpen.Assemblies.Arrangement is currently used in the session. |
| 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. |
| IsIsolated | Get whether this NXOpen.Assemblies.Arrangement is isolated. |
| Prints a representation of this object to the system log file. | |
| 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. |
| 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. |
| SolvePostponedConstraints | Forces a postponed NXOpen.Assemblies.Arrangement, that is not currently used in the session, to solve its constraints. |
Property Detail¶
IgnoringConstraints¶
-
Arrangement.IgnoringConstraints¶ Returns or sets the flag indicating whether this
NXOpen.Assemblies.Arrangementis ignoring constraints.-------------------------------------Getter Method
Signature
IgnoringConstraints()Returns: Whether this NXOpen.Assemblies.Arrangementis ignoring all constraints.Return type: bool New in version NX9.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
-------------------------------------Setter Method
Signature
IgnoringConstraints(isIgnoreConstraints)Parameters: isIgnoreConstraints (bool) – Whether this NXOpen.Assemblies.Arrangementis ignoring all constraints.New in version NX9.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
IsOccurrence¶
-
Arrangement.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¶
-
Arrangement.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¶
-
Arrangement.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.
Owner¶
-
Arrangement.Owner¶ Returns the
NXOpen.Assemblies.ComponentAssemblywhich owns this arrangement-------------------------------------Getter Method
Signature
Owner()Returns: The NXOpen.Assemblies.ComponentAssemblywhich owns this ArrangementReturn type: NXOpen.Assemblies.ComponentAssemblyNew in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
Arrangement.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponent()Returns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
Arrangement.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.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
Arrangement.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.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
Delete¶
-
Arrangement.Delete¶ Delete the given
NXOpen.Assemblies.Arrangement.If the forget_positioning flag is set to TRUE then components will not maintain their positions, otherwise variable component positioning will be created to maintain the components current positions. If the part containing the
NXOpen.Assemblies.Arrangementis not already fully loaded this method will cause it to be.Signature
Delete(forgetPositioning)Parameters: forgetPositioning (bool) – If TRUE then components will not maintain their position. New in version NX7.5.2.
License requirements: assemblies (“ASSEMBLIES MODULE”)
FindObject¶
-
Arrangement.FindObject¶ Finds the
NXOpen.NXObjectwith 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.INXObjectNew in version NX3.0.0.
License requirements: None.
GetHasPostponedConstraints¶
-
Arrangement.GetHasPostponedConstraints¶ Get whether this
NXOpen.Assemblies.Arrangementhas postponed its solve.The solving of constraints is postponed in an
NXOpen.Assemblies.Arrangementthat is not currently used in the session. The constraints will solve when the component positions in theNXOpen.Assemblies.Arrangementare needed.Signature
GetHasPostponedConstraints()Returns: Whether this NXOpen.Assemblies.Arrangementhas postponed solving its constraints.Return type: bool New in version NX9.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetMaintainsConstraints¶
-
Arrangement.GetMaintainsConstraints¶ Get whether this
NXOpen.Assemblies.Arrangementis currently used in the session.If it is, it will be kept up to date.
Signature
GetMaintainsConstraints()Returns: Whether this NXOpen.Assemblies.Arrangementis currently used in the session.Return type: bool New in version NX9.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
IsIsolated¶
-
Arrangement.IsIsolated¶ Get whether this
NXOpen.Assemblies.Arrangementis isolated.An isolated
NXOpen.Assemblies.Arrangementis anNXOpen.Assemblies.Arrangementthat is capable of supporting isolated positions and isolated position overrides.Signature
IsIsolated()Returns: Whether this NXOpen.Assemblies.Arrangementis isolated.Return type: bool New in version NX9.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
Print¶
-
Arrangement.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
Arrangement.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.
SolvePostponedConstraints¶
-
Arrangement.SolvePostponedConstraints¶ Forces a postponed
NXOpen.Assemblies.Arrangement, that is not currently used in the session, to solve its constraints.This could lead to updating the model if required.
Signature
SolvePostponedConstraints()New in version NX9.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)