Positioner Class

class NXOpen.Positioning.Positioner

Bases: NXOpen.NXObject

An instance of this class can be used to create :py:class:`NXOpen.Positioning.Constraint`s and associated objects.

To obtain an instance of this class, use NXOpen.Assemblies.ComponentAssembly.Positioner()

New in version NX4.0.0.

Properties

Property	Description
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.
Constraints	The collection of :py:class:`NXOpen.Positioning.Constraint`s defined in the positioner

Methods

Method	Description
ClearNetwork	Removes the NXOpen.Positioning.Network of the positioner.
CreateAttributeIterator	Create an attribute iterator
CreateConstraint	Creates a new NXOpen.Positioning.Constraint in the positioner.
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteNonPersistentConstraints	Deletes all the non-persistent :py:class:`NXOpen.Positioning.Constraint`s of the positioner.
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
EstablishNetwork	Establishes a NXOpen.Positioning.Network in the positioner.
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.
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
Print	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.
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.

Property Detail

IsOccurrence

Positioner.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

Positioner.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

Positioner.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

Positioner.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

Positioner.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

Positioner.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.

Constraints

Positioner.Constraints

The collection of :py:class:`NXOpen.Positioning.Constraint`s defined in the positioner

Signature Constraints

New in version NX3.0.0.

Returns: Return type:NXOpen.Positioning.ConstraintCollection

Method Detail

ClearNetwork

Positioner.ClearNetwork

Removes the NXOpen.Positioning.Network of the positioner.

The network is added to the delete list by this call.

Signature ClearNetwork()

New in version NX4.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

CreateConstraint

Positioner.CreateConstraint

Creates a new NXOpen.Positioning.Constraint in the positioner.

Signature CreateConstraint(persistent)

Parameters:persistent (bool) – Persistent state of constraint Returns:The new NXOpen.Positioning.Constraint Return type:NXOpen.Positioning.Constraint

New in version NX8.5.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Creates a new NXOpen.Positioning.Constraint in the positioner.

Signature CreateConstraint()

Returns:The new NXOpen.Positioning.Constraint Return type:NXOpen.Positioning.Constraint

New in version NX4.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

DeleteNonPersistentConstraints

Positioner.DeleteNonPersistentConstraints

Deletes all the non-persistent :py:class:`NXOpen.Positioning.Constraint`s of the positioner.

Signature DeleteNonPersistentConstraints()

New in version NX4.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

EstablishNetwork

Positioner.EstablishNetwork

Establishes a NXOpen.Positioning.Network in the positioner.

Signature EstablishNetwork()

Returns:The new NXOpen.Positioning.Network Return type:NXOpen.Positioning.Network

New in version NX4.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

FindObject

Positioner.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.

Print

Positioner.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

Positioner.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.