ChannelAdjustBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ChannelAdjustBuilder Class

class `NXOpen.Tooling.``ChannelAdjustBuilder`

  Bases: `NXOpen.Builder`

  The builder class for Channel Adjust which assists you to adjust the postion and the length of the channel.

  To create a new instance of this class, use `NXOpen.Tooling.ChannelAdjustCollection.CreateChannelAdjustBuilder()`

  Default values.

  Property | Value
  --- | ---
  Distance.Value | 0 (millimeters part), 0 (inches part)
  RepositionMethod | Along

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AdjustMethod | Returns or sets the method for adjusting the cooling channels.
AdjustVector | Returns or sets the vector specified for the adjust direction.
Distance | Returns the distance between the channels and faces.
ReferenceFace | Returns the reference faces for calculating the distance to the cooling channels.
RepositionMethod | Returns or sets the method for moving the cooling channels.
Tag | Returns the Tag for this object.
TargetChannel | Returns the cooling channel to be adjusted.

# 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.
GetObject | Returns the object currently being edited by this builder.
SetManipulatorOriginValue | Sets the manipulator origin.
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

ChannelAdjustBuilderAdjustType Enumeration | the adjust method.
ChannelAdjustBuilderVectorMethod Enumeration | the vector adjust method.

# Property Detail

## AdjustMethod

`ChannelAdjustBuilder.``AdjustMethod`

  Returns or sets the method for adjusting the cooling channels.

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

  Getter Method

  Signature `AdjustMethod`

  Returns: |
  Return type: | `NXOpen.Tooling.ChannelAdjustBuilderAdjustType`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AdjustMethod`

  Parameters: | adjustMethod (`NXOpen.Tooling.ChannelAdjustBuilderAdjustType`) –

  New in version NX7.5.0.

  License requirements: None.

## AdjustVector

`ChannelAdjustBuilder.``AdjustVector`

  Returns or sets the vector specified for the adjust direction.

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

  Getter Method

  Signature `AdjustVector`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AdjustVector`

  Parameters: | adjustVector (`NXOpen.Direction`) –

  New in version NX7.5.0.

  License requirements: None.

## Distance

`ChannelAdjustBuilder.``Distance`

  Returns the distance between the channels and faces.

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

  Getter Method

  Signature `Distance`

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

  New in version NX7.5.0.

  License requirements: None.

## ReferenceFace

`ChannelAdjustBuilder.``ReferenceFace`

  Returns the reference faces for calculating the distance to the cooling channels.

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

  Getter Method

  Signature `ReferenceFace`

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

  New in version NX7.5.0.

  License requirements: None.

## RepositionMethod

`ChannelAdjustBuilder.``RepositionMethod`

  Returns or sets the method for moving the cooling channels.

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

  Getter Method

  Signature `RepositionMethod`

  Returns: |
  Return type: | `NXOpen.Tooling.ChannelAdjustBuilderVectorMethod`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RepositionMethod`

  Parameters: | repositionMethod (`NXOpen.Tooling.ChannelAdjustBuilderVectorMethod`) –

  New in version NX7.5.0.

  License requirements: None.

## TargetChannel

`ChannelAdjustBuilder.``TargetChannel`

  Returns the cooling channel to be adjusted.

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

  Getter Method

  Signature `TargetChannel`

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

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## SetManipulatorOriginValue

`ChannelAdjustBuilder.``SetManipulatorOriginValue`

  Sets the manipulator origin.

  Signature `SetManipulatorOriginValue(moveOrigin)`

  Parameters: | moveOrigin (`NXOpen.Point3d`) –

  New in version NX9.0.2.

  License requirements: ug_mold_design (“UG MOLD”)

## Validate

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