PositioningTask Class¶
-
class
NXOpen.Assemblies.
PositioningTask
¶ Bases:
NXOpen.NXObject
Represents the class for positioning task.
To create or edit an instance of this class, use
NXOpen.Assemblies.PositioningTaskBuilder
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
DisplayConstraints | Returns or sets the flag indicating whether constraints of work collection design elements of this positioning task are to be displayed on the graphics window or not. |
DisplaySuppressedConstraints | Returns or sets the flag indicating whether suppressed constraints of work collection design elements of this positioning task are to be displayed on the graphics window or not. |
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. |
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 |
---|---|
Activate | Activates the NXOpen.Assemblies.PositioningTask . |
ActivatePositioningGroup | Activates the NXOpen.Assemblies.PositioningGroup in the positioning task. |
CheckInPositioningGroups | Checks in the specified :py:class:`NXOpen.Assemblies.PositioningGroup`s which must be associated with this positioning task. |
CheckOutPositioningGroups | Checks out the specified :py:class:`NXOpen.Assemblies.PositioningGroup`s which must be associated with this positioning task. |
CreateAttributeIterator | Create an attribute iterator |
Deactivate | Deactivates the NXOpen.Assemblies.PositioningTask . |
DeactivatePositioningGroup | Deactivates the NXOpen.Assemblies.PositioningGroup in the positioning task. |
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 on the object, if any, that satisfy the given iterator |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAllContextCollectionMembers | Gets all context collection members of NXOpen.Assemblies.PositioningTask . |
GetAllPositioningGroups | Gets all :py:class:`NXOpen.Assemblies.PositioningGroup`s which are associated with this positioning task. |
GetAllWorkCollectionMembers | Gets all work collection members of NXOpen.Assemblies.PositioningTask . |
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. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
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, that satisfy the given iterator. |
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, if any, that satisfy the given iterator. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
IsInContextCollection | Checks whether the input NXOpen.Assemblies.Component is a part of NXOpen.Assemblies.PositioningTask context collection or not. |
IsInWorkCollection | Checks whether the input NXOpen.Assemblies.Component is a part of NXOpen.Assemblies.PositioningTask work collection or not. |
Prints a representation of this object to the system log file. | |
RemoveFromTask | Removes specified NXOpen.Assemblies.PositioningGroup from NXOpen.Assemblies.PositioningTask . |
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. |
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on 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. |
Ungroup | Ungroups the positioning group. |
Property Detail¶
DisplayConstraints¶
-
PositioningTask.
DisplayConstraints
¶ Returns or sets the flag indicating whether constraints of work collection design elements of this positioning task are to be displayed on the graphics window or not.
(This is a separate system from hiding and showing individual constraints.) This flag controls the visibility of both suppressed and unsuppressed constraints.
-------------------------------------
Getter Method
Signature
DisplayConstraints
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayConstraints
Parameters: displayConstraints (bool) – New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
DisplaySuppressedConstraints¶
-
PositioningTask.
DisplaySuppressedConstraints
¶ Returns or sets the flag indicating whether suppressed constraints of work collection design elements of this positioning task are to be displayed on the graphics window or not.
(This is a separate system from hiding and showing individual constraints.)
-------------------------------------
Getter Method
Signature
DisplaySuppressedConstraints
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplaySuppressedConstraints
Parameters: displaySuppressedConstraints (bool) – New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
IsOccurrence¶
-
PositioningTask.
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¶
-
PositioningTask.
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¶
-
PositioningTask.
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¶
-
PositioningTask.
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¶
-
PositioningTask.
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¶
-
PositioningTask.
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¶
Activate¶
-
PositioningTask.
Activate
¶ Activates the
NXOpen.Assemblies.PositioningTask
.Signature
Activate()
New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
ActivatePositioningGroup¶
-
PositioningTask.
ActivatePositioningGroup
¶ Activates the
NXOpen.Assemblies.PositioningGroup
in the positioning task.Signature
ActivatePositioningGroup(positioningGroup)
Parameters: positioningGroup ( NXOpen.Assemblies.PositioningGroup
) –New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
CheckInPositioningGroups¶
-
PositioningTask.
CheckInPositioningGroups
¶ Checks in the specified :py:class:`NXOpen.Assemblies.PositioningGroup`s which must be associated with this positioning task.
Signature
CheckInPositioningGroups(positioningGroups)
Parameters: positioningGroups (list of NXOpen.Assemblies.PositioningGroup
) –Returns: Any errors that occurred during check in of the Positioning Groups Return type: NXOpen.ErrorList
New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
CheckOutPositioningGroups¶
-
PositioningTask.
CheckOutPositioningGroups
¶ Checks out the specified :py:class:`NXOpen.Assemblies.PositioningGroup`s which must be associated with this positioning task.
Signature
CheckOutPositioningGroups(positioningGroups)
Parameters: positioningGroups (list of NXOpen.Assemblies.PositioningGroup
) –Returns: Any errors that occurred during check out of the Positioning Groups Return type: NXOpen.ErrorList
New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
Deactivate¶
-
PositioningTask.
Deactivate
¶ Deactivates the
NXOpen.Assemblies.PositioningTask
.Signature
Deactivate()
New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
DeactivatePositioningGroup¶
-
PositioningTask.
DeactivatePositioningGroup
¶ Deactivates the
NXOpen.Assemblies.PositioningGroup
in the positioning task.Signature
DeactivatePositioningGroup(positioningGroup)
Parameters: positioningGroup ( NXOpen.Assemblies.PositioningGroup
) –New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
FindObject¶
-
PositioningTask.
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.
GetAllContextCollectionMembers¶
-
PositioningTask.
GetAllContextCollectionMembers
¶ Gets all context collection members of
NXOpen.Assemblies.PositioningTask
.Signature
GetAllContextCollectionMembers()
Returns: Return type: list of NXOpen.Assemblies.Component
New in version NX10.0.0.
License requirements: None.
GetAllPositioningGroups¶
-
PositioningTask.
GetAllPositioningGroups
¶ Gets all :py:class:`NXOpen.Assemblies.PositioningGroup`s which are associated with this positioning task.
Signature
GetAllPositioningGroups()
Returns: Return type: list of NXOpen.Assemblies.PositioningGroup
New in version NX10.0.0.
License requirements: None.
GetAllWorkCollectionMembers¶
-
PositioningTask.
GetAllWorkCollectionMembers
¶ Gets all work collection members of
NXOpen.Assemblies.PositioningTask
.Signature
GetAllWorkCollectionMembers()
Returns: Return type: list of NXOpen.Assemblies.Component
New in version NX10.0.0.
License requirements: None.
IsInContextCollection¶
-
PositioningTask.
IsInContextCollection
¶ Checks whether the input
NXOpen.Assemblies.Component
is a part ofNXOpen.Assemblies.PositioningTask
context collection or not.Signature
IsInContextCollection(component)
Parameters: component ( NXOpen.Assemblies.Component
) –Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
IsInWorkCollection¶
-
PositioningTask.
IsInWorkCollection
¶ Checks whether the input
NXOpen.Assemblies.Component
is a part ofNXOpen.Assemblies.PositioningTask
work collection or not.Signature
IsInWorkCollection(component)
Parameters: component ( NXOpen.Assemblies.Component
) –Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Print¶
-
PositioningTask.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveFromTask¶
-
PositioningTask.
RemoveFromTask
¶ Removes specified
NXOpen.Assemblies.PositioningGroup
fromNXOpen.Assemblies.PositioningTask
.Signature
RemoveFromTask(positioningGroup)
Parameters: positioningGroup ( NXOpen.Assemblies.PositioningGroup
) –New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
SetName¶
-
PositioningTask.
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.
Ungroup¶
-
PositioningTask.
Ungroup
¶ Ungroups the positioning group.
It will delete positioning group and move all its members to work collection of this
NXOpen.Assemblies.PositioningTask
.Signature
Ungroup(positioningGroup)
Parameters: positioningGroup ( NXOpen.Assemblies.PositioningGroup
) –New in version NX10.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)