PackagingMeasureBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PackagingMeasureBuilder Class

class `NXOpen.Motion.``PackagingMeasureBuilder`

  Bases: `NXOpen.Motion.PackagingBuilder`

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

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

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
Condition | Returns or sets the measure condition defined at `NXOpen.Motion.PackagingMeasureBuilderMeasureCondition`
Enable | Returns or sets the enable flag of `NXOpen.Motion.Packaging` object.
MsType | Returns or sets the Measure type defined at `NXOpen.Motion.PackagingMeasureBuilderMeasureType`
Name | Returns or sets the name of `NXOpen.Motion.Packaging` object.
StopOnEvent | Returns or sets the Stop_On_Event flag of `NXOpen.Motion.PackagingMeasure` object
Tag | Returns the Tag for this object.
ThresholdAngleExpression | Returns the Measure angular threshold expression value
ThresholdExpression | Returns the Measure threshold expression value
ToleranceAngleExpression | Returns the Measure angular tolerance expression value
ToleranceExpression | Returns the Measure tolerance expression value

# 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.
GetList2 | Returns the geometry list 2 of `NXOpen.Motion.PackagingMeasure` object.
GetObject | Returns the object currently being edited by this builder.
GetSourceList | Gets the source geometry data.
GetTargetList | Gets the target geometry data.
SetList1 | Sets geometry list 1.
SetList2 | Sets the geometry list 2.
SetSourceList | Sets the source geometry data.
SetTargetList | Sets the target geometry data.
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

PackagingMeasureBuilderMeasureCondition Enumeration | Measure condition
PackagingMeasureBuilderMeasureType Enumeration | Measure type

# Structs

PackagingMeasureBuilderGeometryData_Struct Struct | Represents geometry data.

# Property Detail

## Condition

`PackagingMeasureBuilder.``Condition`

  Returns or sets the measure condition defined at `NXOpen.Motion.PackagingMeasureBuilderMeasureCondition`

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

  Getter Method

  Signature `Condition`

  Returns: |
  Return type: | `NXOpen.Motion.PackagingMeasureBuilderMeasureCondition`

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `Condition`

  Parameters: | condition (`NXOpen.Motion.PackagingMeasureBuilderMeasureCondition`) –

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## MsType

`PackagingMeasureBuilder.``MsType`

  Returns or sets the Measure type defined at `NXOpen.Motion.PackagingMeasureBuilderMeasureType`

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

  Getter Method

  Signature `MsType`

  Returns: |
  Return type: | `NXOpen.Motion.PackagingMeasureBuilderMeasureType`

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `MsType`

  Parameters: | mType (`NXOpen.Motion.PackagingMeasureBuilderMeasureType`) –

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StopOnEvent

`PackagingMeasureBuilder.``StopOnEvent`

  Returns or sets the Stop_On_Event flag of `NXOpen.Motion.PackagingMeasure` object

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

  Getter Method

  Signature `StopOnEvent`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `StopOnEvent`

  Parameters: | stopOnEvent (bool) –

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## ThresholdAngleExpression

`PackagingMeasureBuilder.``ThresholdAngleExpression`

  Returns the Measure angular threshold expression value

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

  Getter Method

  Signature `ThresholdAngleExpression`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## ThresholdExpression

`PackagingMeasureBuilder.``ThresholdExpression`

  Returns the Measure threshold expression value

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

  Getter Method

  Signature `ThresholdExpression`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## ToleranceAngleExpression

`PackagingMeasureBuilder.``ToleranceAngleExpression`

  Returns the Measure angular tolerance expression value

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

  Getter Method

  Signature `ToleranceAngleExpression`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## ToleranceExpression

`PackagingMeasureBuilder.``ToleranceExpression`

  Returns the Measure tolerance expression value

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

  Getter Method

  Signature `ToleranceExpression`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## GetList2

`PackagingMeasureBuilder.``GetList2`

  Returns the geometry list 2 of `NXOpen.Motion.PackagingMeasure` object.

  Measure can have one or two lists defined. If the user defines two lists, then measurements will be done between each object in list 1 against each object in list 2.

  Signature `GetList2()`

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

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## GetSourceList

`PackagingMeasureBuilder.``GetSourceList`

  Gets the source geometry data.

  Signature `GetSourceList()`

  Returns: | Source geometry data
  Return type: | list of `NXOpen.Motion.PackagingMeasureBuilderGeometryData_Struct`

  New in version NX7.5.0.

  License requirements: mechanisms (“MECHANISMS”)

## GetTargetList

`PackagingMeasureBuilder.``GetTargetList`

  Gets the target geometry data.

  Signature `GetTargetList()`

  Returns: | Target geometry data
  Return type: | list of `NXOpen.Motion.PackagingMeasureBuilderGeometryData_Struct`

  New in version NX7.5.0.

  License requirements: mechanisms (“MECHANISMS”)

## SetList2

`PackagingMeasureBuilder.``SetList2`

  Sets the geometry list 2.

  Signature `SetList2(list2)`

  Parameters: | list2 (list of `NXOpen.DisplayableObject`) –

  New in version NX4.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## SetSourceList

`PackagingMeasureBuilder.``SetSourceList`

  Sets the source geometry data.

  Signature `SetSourceList(sourceGeometryData)`

  Parameters: | sourceGeometryData (list of `NXOpen.Motion.PackagingMeasureBuilderGeometryData_Struct`) – Source geometry data

  New in version NX7.5.0.

  License requirements: mechanisms (“MECHANISMS”)

## SetTargetList

`PackagingMeasureBuilder.``SetTargetList`

  Sets the target geometry data.

  Signature `SetTargetList(targetGeometryData)`

  Parameters: | targetGeometryData (list of `NXOpen.Motion.PackagingMeasureBuilderGeometryData_Struct`) – Target geometry data

  New in version NX7.5.0.

  License requirements: mechanisms (“MECHANISMS”)

## Validate

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