PackagingTraceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PackagingTraceBuilder Class

class `NXOpen.Motion.``PackagingTraceBuilder`

  Bases: `NXOpen.Motion.PackagingBuilder`

  This is the builder class to create or edit a Trace object.

  To create a new instance of this class, use `NXOpen.Motion.PackagingCollection.CreateTraceBuilder()`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
Enable | Returns or sets the enable flag of `NXOpen.Motion.Packaging` object.
FrameType | Returns or sets the `NXOpen.Motion.PackagingTrace` reference frame type defined at `NXOpen.Motion.PackagingTraceBuilderFrame`
Name | Returns or sets the name of `NXOpen.Motion.Packaging` object.
Tag | Returns the Tag for this object.
TargetLayer | Returns or sets the `NXOpen.Motion.PackagingTrace` target layer

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetList1 | Returns geometry list 1 of `NXOpen.Motion.Packaging` object.
GetObject | Returns the object currently being edited by this builder.
GetRelativeLinks | Returns `NXOpen.Motion.PackagingTrace` relative links.
SetList1 | Sets geometry list 1.
SetRelativeLinks | Sets `NXOpen.Motion.PackagingTrace` relative links.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

PackagingTraceBuilderFrame Enumeration | Trace reference frame type

# Property Detail

## FrameType

`PackagingTraceBuilder.``FrameType`

  Returns or sets the `NXOpen.Motion.PackagingTrace` reference frame type defined at `NXOpen.Motion.PackagingTraceBuilderFrame`

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

  Getter Method

  Signature `FrameType`

  Returns: | Trace reference frame type defined in

  `NXOpen.Motion.PackagingTraceBuilderFrame` :rtype: `NXOpen.Motion.PackagingTraceBuilderFrame`

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `FrameType`

  Parameters: | fType (`NXOpen.Motion.PackagingTraceBuilderFrame`) – Trace reference frame type defined in `NXOpen.Motion.PackagingTraceBuilderFrame`

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## TargetLayer

`PackagingTraceBuilder.``TargetLayer`

  Returns or sets the `NXOpen.Motion.PackagingTrace` target layer

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

  Getter Method

  Signature `TargetLayer`

  Returns: | Target layer
  Return type: | int

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `TargetLayer`

  Parameters: | targetLayer (int) – Target layer

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## GetRelativeLinks

`PackagingTraceBuilder.``GetRelativeLinks`

  Returns `NXOpen.Motion.PackagingTrace` relative links.

  Only available when frame type is :py:class:` NXOpen.Motion.PackagingTraceBuilderFrame.Relative < NXOpen.Motion.PackagingTraceBuilderFrame>`.

  Signature `GetRelativeLinks()`

  Returns: | The list pointer
  Return type: | list of `NXOpen.DisplayableObject`

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## SetRelativeLinks

`PackagingTraceBuilder.``SetRelativeLinks`

  Sets `NXOpen.Motion.PackagingTrace` relative links.

  Only used when frame type is :py:class:` NXOpen.Motion.PackagingTraceBuilderFrame.Relative < NXOpen.Motion.PackagingTraceBuilderFrame>`.

  Signature `SetRelativeLinks(links)`

  Parameters: | links (list of `NXOpen.DisplayableObject`) – The list pointer

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Validate

`PackagingTraceBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.