SIZERExportBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SIZERExportBuilder Class

class `NXOpen.Tooling.``SIZERExportBuilder`

  Bases: `NXOpen.Builder`

  Exports input parameters for motor selection to SIZER drive design to support the sizing, configuration, and selection of drive components.

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

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
OutputFile | Returns or sets the output *.
Tag | Returns the Tag for this object.

# 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.
GetMcdMechanicalData | Gets all groups of mechanical data in MCD mode.
GetMechanicalData | Gets all groups of mechanical data in Motion mode.
GetObject | Returns the object currently being edited by this builder.
GetRunMode | Gets the run mode.
ProcessMcdSimulationData | Processes the simulation data in MCD mode.
SetMcdMechanicalData | Sets all groups of mechanical data in MCD mode.
SetMechanicalData | Sets all groups of mechanical data in Motion mode.
SetRunMode | Sets the run mode.
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

SIZERExportBuilderRunMode Enumeration | Represents the run mode.

# Structs

SIZERExportBuilderMCDMechanicalData_Struct Struct | Defines the mechanical data in MCD mode.
SIZERExportBuilderMechanicalData_Struct Struct | Defines the mechanical data in Motion mode.

# Property Detail

## OutputFile

`SIZERExportBuilder.``OutputFile`

  Returns or sets the output *.

  mdix file, which is exported to SIZER.

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

  Getter Method

  Signature `OutputFile`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputFile`

  Parameters: | outputFile (str) –

  New in version NX7.5.0.

  License requirements: mechanisms (“MECHANISMS”) OR nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## GetMcdMechanicalData

`SIZERExportBuilder.``GetMcdMechanicalData`

  Gets all groups of mechanical data in MCD mode.

  Signature `GetMcdMechanicalData()`

  Returns: | Array of mechanical data
  Return type: | list of `NXOpen.Tooling.SIZERExportBuilderMCDMechanicalData_Struct`

  New in version NX9.0.0.

  License requirements: None.

## GetMechanicalData

`SIZERExportBuilder.``GetMechanicalData`

  Gets all groups of mechanical data in Motion mode.

  Signature `GetMechanicalData()`

  Returns: | Array of mechanical data
  Return type: | list of `NXOpen.Tooling.SIZERExportBuilderMechanicalData_Struct`

  New in version NX7.5.0.

  License requirements: None.

## GetRunMode

`SIZERExportBuilder.``GetRunMode`

  Gets the run mode.

  Signature `GetRunMode()`

  Returns: | Run mode
  Return type: | `NXOpen.Tooling.SIZERExportBuilderRunMode`

  New in version NX9.0.0.

  License requirements: None.

## ProcessMcdSimulationData

`SIZERExportBuilder.``ProcessMcdSimulationData`

  Processes the simulation data in MCD mode.

  Signature `ProcessMcdSimulationData(startTime, endTime)`

  Parameters:

  - startTime (float) – Start Time of simulation
  - endTime (float) – End Time of simulation

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetMcdMechanicalData

`SIZERExportBuilder.``SetMcdMechanicalData`

  Sets all groups of mechanical data in MCD mode.

  Signature `SetMcdMechanicalData(mechanicalData)`

  Parameters: | mechanicalData (list of `NXOpen.Tooling.SIZERExportBuilderMCDMechanicalData_Struct`) – Array of mechanical data

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetMechanicalData

`SIZERExportBuilder.``SetMechanicalData`

  Sets all groups of mechanical data in Motion mode.

  Signature `SetMechanicalData(mechanicalData)`

  Parameters: | mechanicalData (list of `NXOpen.Tooling.SIZERExportBuilderMechanicalData_Struct`) – Array of mechanical data

  New in version NX7.5.0.

  License requirements: mechanisms (“MECHANISMS”)

## SetRunMode

`SIZERExportBuilder.``SetRunMode`

  Sets the run mode.

  Signature `SetRunMode(runMode)`

  Parameters: | runMode (`NXOpen.Tooling.SIZERExportBuilderRunMode`) – Run mode

  New in version NX9.0.0.

  License requirements: mechanisms (“MECHANISMS”) OR nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

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