KinematicJunctionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# KinematicJunctionBuilder Class

class `NXOpen.SIM.``KinematicJunctionBuilder`

  Bases: `NXOpen.Builder`

  Represents the SimKimJunctionBuilder class object

  Use the `NXOpen.SIM.KinematicConfigurator` class to create a KinematicJunctionBuilder object.

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
Classification | Returns or sets the classification of the junction
Csys | Returns or sets the CSYS associated with the junction
Name | Returns or sets the kim junction’s name
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateDefaultCsys | Create the default CSYS based on WCS
CreateTooltipCsys | Create the tooltip CSYS
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.
IsMachineZero | Test if this is a machine zero junction
IsToolMount | Test if the junction is a tool mount junctions
IsToolTip | Test if the junction is a tool tip junctions
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

KinematicJunctionBuilderSystemClass Enumeration | The junction system classes

# Property Detail

## Classification

`KinematicJunctionBuilder.``Classification`

  Returns or sets the classification of the junction

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

  Getter Method

  Signature `Classification`

  Returns: | the classification of the junction
  Return type: | `NXOpen.SIM.KinematicJunctionBuilderSystemClass`

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

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

  Setter Method

  Signature `Classification`

  Parameters: | jctClass (`NXOpen.SIM.KinematicJunctionBuilderSystemClass`) – the classification of the junction

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

## Csys

`KinematicJunctionBuilder.``Csys`

  Returns or sets the CSYS associated with the junction

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

  Getter Method

  Signature `Csys`

  Returns: | the csys
  Return type: | `NXOpen.CartesianCoordinateSystem`

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

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

  Setter Method

  Signature `Csys`

  Parameters: | csys (`NXOpen.CartesianCoordinateSystem`) – the csys

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

## Name

`KinematicJunctionBuilder.``Name`

  Returns or sets the kim junction’s name

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

  Getter Method

  Signature `Name`

  Returns: | The junction’s name
  Return type: | str

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

  Setter Method

  Signature `Name`

  Parameters: | name (str) – the junction’s new name

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

# Method Detail

## CreateDefaultCsys

`KinematicJunctionBuilder.``CreateDefaultCsys`

  Create the default CSYS based on WCS

  Signature `CreateDefaultCsys()`

  Returns: | the default csys
  Return type: | `NXOpen.CartesianCoordinateSystem`

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

## CreateTooltipCsys

`KinematicJunctionBuilder.``CreateTooltipCsys`

  Create the tooltip CSYS

  Signature `CreateTooltipCsys()`

  Returns: | the tooltip csys
  Return type: | `NXOpen.CartesianCoordinateSystem`

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

## IsMachineZero

`KinematicJunctionBuilder.``IsMachineZero`

  Test if this is a machine zero junction

  Signature `IsMachineZero()`

  Returns: | true if it is the machine zero junction
  Return type: | bool

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

## IsToolMount

`KinematicJunctionBuilder.``IsToolMount`

  Test if the junction is a tool mount junctions

  Signature `IsToolMount()`

  Returns: | true if it is a tool mount junction
  Return type: | bool

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

## IsToolTip

`KinematicJunctionBuilder.``IsToolTip`

  Test if the junction is a tool tip junctions

  Signature `IsToolTip()`

  Returns: | true if it is a tool tip junction
  Return type: | bool

  New in version NX7.5.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

## Validate

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