ECADImportBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ECADImportBuilder Class

class `NXOpen.Mechatronics.``ECADImportBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.ECADImportBuilder`

  To create a new instance of this class, use `NXOpen.Mechatronics.PhysicsManager.CreateECADImportBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
ImportFile | Returns or sets the import file name
PositionMethod | Returns or sets the position method, which is used in adding to assembly.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CompareObjects | Compares imported ECAD objects with logical objects.
CreateLogicalNode | Creates logical node in system navigator.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
EditLogicalNode | Edits logical node in system navigator.
GenerateEcadModelComponent | Generates ECAD model component.
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.
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

ECADImportBuilderPositionMode Enumeration | Represents the position mode.

# Property Detail

## ImportFile

`ECADImportBuilder.``ImportFile`

  Returns or sets the import file name

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

  Getter Method

  Signature `ImportFile`

  Returns: | The import file name
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ImportFile`

  Parameters: | importFile (str) – The import file name

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## PositionMethod

`ECADImportBuilder.``PositionMethod`

  Returns or sets the position method, which is used in adding to assembly.

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

  Getter Method

  Signature `PositionMethod`

  Returns: |
  Return type: | `NXOpen.Mechatronics.ECADImportBuilderPositionMode`

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: This method has no replacement. It is no longer supported.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `PositionMethod`

  Parameters: | positionMethod (`NXOpen.Mechatronics.ECADImportBuilderPositionMode`) –

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: This method has no replacement. It is no longer supported.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## CompareObjects

`ECADImportBuilder.``CompareObjects`

  Compares imported ECAD objects with logical objects.

  Signature `CompareObjects()`

  Returns: | The comparison result context
  Return type: | `NXOpen.Mechatronics.ComparisonResultContext`

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## CreateLogicalNode

`ECADImportBuilder.``CreateLogicalNode`

  Creates logical node in system navigator.

  Signature `CreateLogicalNode(referenceDesignator)`

  Parameters: | referenceDesignator (str) – Multiple Reference Designator
  Returns: |
  Return type: | `NXOpen.Mechatronics.LogicObject`

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: This method has no replacement. It is no longer supported.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## EditLogicalNode

`ECADImportBuilder.``EditLogicalNode`

  Edits logical node in system navigator.

  Signature `EditLogicalNode(logicalNode, itemName, itemId, oldPartOcc, newPartOcc, parameterData)`

  Parameters:

  - logicalNode (`NXOpen.Mechatronics.LogicObject`) –
  - itemName (str) – Logical Item Name
  - itemId (str) – Logical Item ID
  - oldPartOcc (`NXOpen.Assemblies.Component`) – Old Component
  - newPartOcc (`NXOpen.Assemblies.Component`) – New Component
  - parameterData (list of `NXOpen.Mechatronics.LogicObjectBuilderParameterData_Struct`) – Parameter Data Array

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: This method has no replacement. It is no longer supported.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## GenerateEcadModelComponent

`ECADImportBuilder.``GenerateEcadModelComponent`

  Generates ECAD model component.

  Signature `GenerateEcadModelComponent(partName)`

  Parameters: | partName (str) – ECAD Model Part Name
  Returns: |
  Return type: | `NXOpen.BasePart`

  New in version NX8.5.0.

  Deprecated since version NX9.0.0: This method has no replacement. It is no longer supported.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

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