ComponentPositioner Class — NXOpen Python API Reference 12.0.0 documentation

# ComponentPositioner Class

class `NXOpen.Positioning.``ComponentPositioner`

  Bases: `NXOpen.Positioning.Positioner`

  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
--- | ---
DisplayConstraints | Returns or sets the flag indicating whether constraints in the part of this positioner are to be displayed on the graphics window or not.
DisplaySuppressedConstraints | Returns or sets the flag indicating whether suppressed constraints in the part of this positioner 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.
MoveDumbGeometry | Returns or sets the flag that enables the positioner to reposition dumb geometry.
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
PrimaryArrangement | Returns or sets the `NXOpen.Assemblies.Arrangement` in which the primary `NXOpen.Positioning.Network` will solve.
Prototype | Returns the prototype of this object if it is an occurrence.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
BeginAssemblyConstraints | Begins a mode of operation where (1) each new `NXOpen.Positioning.Constraint` created by this `NXOpen.Positioning.ComponentPositioner` applies to components in the part of the positioner (or to components with variable component positioning defined in the part of the positioner) and (2) and component transforms derived from a `NXOpen.Positioning.Network` will apply to components in the part of the positioner.
BeginMoveComponent | Begins a mode of operation where (1) each new `NXOpen.Positioning.Constraint` is created as transient and (2) a component transform is applied at the level where position is controlled for the component, typically in the component’s immediate parent.
BeginMoveComponentInWorkset | Begins a mode of operation where (1) each new `NXOpen.Positioning.Constraint` is created as transient and (2) a component transform is applied at the workset level.
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
EndAssemblyConstraints | Ends the mode of operation started by `NXOpen.Positioning.ComponentPositioner.BeginAssemblyConstraints()` All non-persistent constraints in this `NXOpen.Positioning.ComponentPositioner` will be deleted.
EndMoveComponent | Ends the mode of operation started by `NXOpen.Positioning.ComponentPositioner.BeginMoveComponent()` All constraints created while in that mode will be deleted.
EndMoveComponentInWorkset | Ends the mode of operation started by `NXOpen.Positioning.ComponentPositioner.BeginMoveComponentInWorkset()` All constraints created while in that mode will be deleted.
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
LoadConstraintGeometry | Attempts to load all the parts that contain unloaded geometry that is referenced by the constraints or by any related constraints.
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.
SolvePostponedConstraints | Solves constraints in all arrangements that are currently postponing their solve.

# Property Detail

## DisplayConstraints

`ComponentPositioner.``DisplayConstraints`

  Returns or sets the flag indicating whether constraints in the part of this positioner 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 NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `DisplayConstraints`

  Parameters: | display (bool) –

  New in version NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## DisplaySuppressedConstraints

`ComponentPositioner.``DisplaySuppressedConstraints`

  Returns or sets the flag indicating whether suppressed constraints in the part of this positioner 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 NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `DisplaySuppressedConstraints`

  Parameters: | display (bool) –

  New in version NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## IsOccurrence

`ComponentPositioner.``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

`ComponentPositioner.``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.

## MoveDumbGeometry

`ComponentPositioner.``MoveDumbGeometry`

  Returns or sets the flag that enables the positioner to reposition dumb geometry.

  Dumb geometry is any geometry that is not controlled by another object such as a `NXOpen.Features.Feature` object. This flag has no effect on Routing geometry (segments and control points) as they are always considered movable by the positioner.

  `-------------------------------------`

  Getter Method

  Signature `MoveDumbGeometry`

  Returns: | Whether the positioner will reposition dumb geometry
  Return type: | bool

  New in version NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `MoveDumbGeometry`

  Parameters: | moveDumbGeometry (bool) – Whether the positioner will reposition dumb geometry

  New in version NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## Name

`ComponentPositioner.``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

`ComponentPositioner.``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

`ComponentPositioner.``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.

## PrimaryArrangement

`ComponentPositioner.``PrimaryArrangement`

  Returns or sets the `NXOpen.Assemblies.Arrangement` in which the primary `NXOpen.Positioning.Network` will solve.

  `-------------------------------------`

  Getter Method

  Signature `PrimaryArrangement`

  Returns: | The primary `NXOpen.Assemblies.Arrangement`.
  Return type: | `NXOpen.Assemblies.Arrangement`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `PrimaryArrangement`

  Parameters: | arrangement (`NXOpen.Assemblies.Arrangement`) – The primary `NXOpen.Assemblies.Arrangement`.

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## Prototype

`ComponentPositioner.``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

## BeginAssemblyConstraints

`ComponentPositioner.``BeginAssemblyConstraints`

  Begins a mode of operation where (1) each new `NXOpen.Positioning.Constraint` created by this `NXOpen.Positioning.ComponentPositioner` applies to components in the part of the positioner (or to components with variable component positioning defined in the part of the positioner) and (2) and component transforms derived from a `NXOpen.Positioning.Network` will apply to components in the part of the positioner.

  Signature `BeginAssemblyConstraints()`

  New in version NX5.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## BeginMoveComponent

`ComponentPositioner.``BeginMoveComponent`

  Begins a mode of operation where (1) each new `NXOpen.Positioning.Constraint` is created as transient and (2) a component transform is applied at the level where position is controlled for the component, typically in the component’s immediate parent.

  Signature `BeginMoveComponent()`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## BeginMoveComponentInWorkset

`ComponentPositioner.``BeginMoveComponentInWorkset`

  Begins a mode of operation where (1) each new `NXOpen.Positioning.Constraint` is created as transient and (2) a component transform is applied at the workset level.

  Signature `BeginMoveComponentInWorkset()`

  New in version NX12.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## EndAssemblyConstraints

`ComponentPositioner.``EndAssemblyConstraints`

  Ends the mode of operation started by `NXOpen.Positioning.ComponentPositioner.BeginAssemblyConstraints()` All non-persistent constraints in this `NXOpen.Positioning.ComponentPositioner` will be deleted.

  Signature `EndAssemblyConstraints()`

  New in version NX5.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## EndMoveComponent

`ComponentPositioner.``EndMoveComponent`

  Ends the mode of operation started by `NXOpen.Positioning.ComponentPositioner.BeginMoveComponent()` All constraints created while in that mode will be deleted.

  Signature `EndMoveComponent()`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## EndMoveComponentInWorkset

`ComponentPositioner.``EndMoveComponentInWorkset`

  Ends the mode of operation started by `NXOpen.Positioning.ComponentPositioner.BeginMoveComponentInWorkset()` All constraints created while in that mode will be deleted.

  Signature `EndMoveComponentInWorkset()`

  New in version NX12.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## FindObject

`ComponentPositioner.``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.

## LoadConstraintGeometry

`ComponentPositioner.``LoadConstraintGeometry`

  Attempts to load all the parts that contain unloaded geometry that is referenced by the constraints or by any related constraints.

  The constraints must be within the positioner otherwise an error will be raised. Any constraints that are suppressed will be ignored.

  If the number of constraints is zero then the function attempts to load the parts for every unsuppressed constraint in the positioner.

  Calling this function can cause objects to be logged for update and therefore the caller of this function must call update.

  Signature `LoadConstraintGeometry(constraints)`

  Parameters: | constraints (list of `NXOpen.Positioning.ComponentConstraint`) – Constraints

  New in version NX7.5.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## Print

`ComponentPositioner.``Print`

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

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## SetName

`ComponentPositioner.``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

`ComponentPositioner.``SolvePostponedConstraints`

  Solves constraints in all arrangements that are currently postponing their solve.

  This could lead to updating the model if required. This call will have no effect if assembly constraint update has been delayed.

  Signature `SolvePostponedConstraints()`

  New in version NX9.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)