SimulationOptionsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SimulationOptionsBuilder Class

class `NXOpen.CAM.``SimulationOptionsBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.CAM.SimulationOptionsBuilder`

  To create a new instance of this class, use `NXOpen.SIM.KinematicConfigurator.CreateSimulationOptionsBuilder()`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AnalyzeMachiningTime | Returns or sets the option to activate the machining time analysis
AnimationAccuracy | Returns or sets the animation accuracy
CacheNcProgram | Returns or sets the cache nc program
CheckLimitViolation | Returns or sets the check limit violation
CheckToolHolder | Returns or sets the check for tool holder collision
ChordalTolerance | Returns or sets the chordal tolerance
CollisionConfigurationBuilder | Returns the collision configuration builder
Collshape | Returns or sets the tool shape for collision
DetectAirCuttingTime | Returns or sets the option to detect the material/air cuts during the cutting time
DisplayByTime | Returns or sets the display by time
DisplayStationary | Returns or sets the display stationary
EnableCollision | Returns or sets the enable collision
EnableDisplay | Returns or sets the enable display
EnableIpw | Returns or sets the enable ipw
HideBlankGeometry | Returns or sets the hide blank geometry
HidePartGeometry | Returns or sets the hide part geometry
HistoryBuffer | Returns or sets the history buffer
InterpretContactContour | Returns or sets the interpret G41/42 as contact contour
IpwColor | Returns or sets the ipw color
IpwResolution | Returns or sets the ipw resolution
MaxAngularIncr | Returns or sets the max angular incr
MaxLengthIncr | Returns or sets the max length incr
MaxTimeIncr | Returns or sets the max time incr
MinSimulationTime | Returns or sets the minimum simulation time
Mrshape | Returns or sets the tool shape for material removal
SaveAsPartfile | Returns or sets the save as partfile
SimulationDisplay | Returns or sets the option to control the display update.
StockSetting | Returns or sets the stock setting
StockValue | Returns or sets the stock value
StopOnCollision | Returns or sets the stop on collision
StopOnHistoryBuffer | Returns or sets the stop on history buffer
StopOnLimitViolation | Returns or sets the stop on limit violation
StopOnRapidThroughIpw | Returns or sets the stop on rapid through ipw
Tag | Returns the Tag for this object.
ToolTraceSize | Returns or sets the tool trace size
TranslucencyValue | Returns or sets the translucency 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.
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

SimulationOptionsBuilderAccuracy Enumeration | The ipw animation accuracy options
SimulationOptionsBuilderDialogType Enumeration | the dialog type
SimulationOptionsBuilderEnable Enumeration | the enable value
SimulationOptionsBuilderIpwEnable Enumeration | the ipw mode value
SimulationOptionsBuilderResolution Enumeration | The ipw resolution options
SimulationOptionsBuilderSimulationDisplayMode Enumeration | The modes of the simulation display. - :py:class:` NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode.SuppressAll < NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode>` will suppress display updates in graphics windows and NC program in Simulation Control Panel. - :py:class:` NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode.SuppressGraphics < NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode>` will suppress display updates in graphics windows. - :py:class:` NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode.All < NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode>` will show all display updates in graphics windows and NC program in Simulation Control Panel.
SimulationOptionsBuilderStationary Enumeration | The stationary options
SimulationOptionsBuilderStockType Enumeration | Gouge Check Stock options
SimulationOptionsBuilderToolShapeColl Enumeration | The tool shape for checking options
SimulationOptionsBuilderToolShapeMR Enumeration | The tool shape for material removal options

# Property Detail

## AnalyzeMachiningTime

`SimulationOptionsBuilder.``AnalyzeMachiningTime`

  Returns or sets the option to activate the machining time analysis

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

  Getter Method

  Signature `AnalyzeMachiningTime`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `AnalyzeMachiningTime`

  Parameters: | analyzeMachiningTime (bool) –

  New in version NX11.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## AnimationAccuracy

`SimulationOptionsBuilder.``AnimationAccuracy`

  Returns or sets the animation accuracy

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

  Getter Method

  Signature `AnimationAccuracy`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderAccuracy`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AnimationAccuracy`

  Parameters: | animationAccuracy (`NXOpen.CAM.SimulationOptionsBuilderAccuracy`) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## CacheNcProgram

`SimulationOptionsBuilder.``CacheNcProgram`

  Returns or sets the cache nc program

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

  Getter Method

  Signature `CacheNcProgram`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CacheNcProgram`

  Parameters: | cacheNcProgram (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## CheckLimitViolation

`SimulationOptionsBuilder.``CheckLimitViolation`

  Returns or sets the check limit violation

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

  Getter Method

  Signature `CheckLimitViolation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckLimitViolation`

  Parameters: | checkLimitViolation (bool) –

  New in version NX9.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## CheckToolHolder

`SimulationOptionsBuilder.``CheckToolHolder`

  Returns or sets the check for tool holder collision

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

  Getter Method

  Signature `CheckToolHolder`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckToolHolder`

  Parameters: | checkToolHolder (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## ChordalTolerance

`SimulationOptionsBuilder.``ChordalTolerance`

  Returns or sets the chordal tolerance

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

  Getter Method

  Signature `ChordalTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ChordalTolerance`

  Parameters: | chordalTolerance (float) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## CollisionConfigurationBuilder

`SimulationOptionsBuilder.``CollisionConfigurationBuilder`

  Returns the collision configuration builder

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

  Getter Method

  Signature `CollisionConfigurationBuilder`

  Returns: | the collision configuration builder
  Return type: | `NXOpen.CAM.CollisionConfigurationBuilder`

  New in version NX8.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## Collshape

`SimulationOptionsBuilder.``Collshape`

  Returns or sets the tool shape for collision

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

  Getter Method

  Signature `Collshape`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderToolShapeColl`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Collshape`

  Parameters: | toolShape (`NXOpen.CAM.SimulationOptionsBuilderToolShapeColl`) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## DetectAirCuttingTime

`SimulationOptionsBuilder.``DetectAirCuttingTime`

  Returns or sets the option to detect the material/air cuts during the cutting time

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

  Getter Method

  Signature `DetectAirCuttingTime`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

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

  Setter Method

  Signature `DetectAirCuttingTime`

  Parameters: | detectAirCuttingTime (bool) –

  New in version NX11.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## DisplayByTime

`SimulationOptionsBuilder.``DisplayByTime`

  Returns or sets the display by time

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

  Getter Method

  Signature `DisplayByTime`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DisplayByTime`

  Parameters: | displayByTime (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## DisplayStationary

`SimulationOptionsBuilder.``DisplayStationary`

  Returns or sets the display stationary

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

  Getter Method

  Signature `DisplayStationary`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderStationary`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DisplayStationary`

  Parameters: | displayStationary (`NXOpen.CAM.SimulationOptionsBuilderStationary`) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## EnableCollision

`SimulationOptionsBuilder.``EnableCollision`

  Returns or sets the enable collision

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

  Getter Method

  Signature `EnableCollision`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderEnable`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EnableCollision`

  Parameters: | enableValue (`NXOpen.CAM.SimulationOptionsBuilderEnable`) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## EnableDisplay

`SimulationOptionsBuilder.``EnableDisplay`

  Returns or sets the enable display

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

  Getter Method

  Signature `EnableDisplay`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderEnable`

  New in version NX6.0.0.

  Deprecated since version NX10.0.2: Use `CAM.SimulationOptionsBuilder.SimulationDisplay()` instead.

  License requirements: None.

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

  Setter Method

  Signature `EnableDisplay`

  Parameters: | enableValue (`NXOpen.CAM.SimulationOptionsBuilderEnable`) –

  New in version NX6.0.0.

  Deprecated since version NX10.0.2: Use `CAM.SimulationOptionsBuilder.SimulationDisplay()` instead.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## EnableIpw

`SimulationOptionsBuilder.``EnableIpw`

  Returns or sets the enable ipw

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

  Getter Method

  Signature `EnableIpw`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderIpwEnable`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EnableIpw`

  Parameters: | enableValue (`NXOpen.CAM.SimulationOptionsBuilderIpwEnable`) –

  New in version NX8.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## HideBlankGeometry

`SimulationOptionsBuilder.``HideBlankGeometry`

  Returns or sets the hide blank geometry

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

  Getter Method

  Signature `HideBlankGeometry`

  Returns: |
  Return type: | bool

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `HideBlankGeometry`

  Parameters: | hideBlankGeo (bool) –

  New in version NX9.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## HidePartGeometry

`SimulationOptionsBuilder.``HidePartGeometry`

  Returns or sets the hide part geometry

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

  Getter Method

  Signature `HidePartGeometry`

  Returns: |
  Return type: | bool

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `HidePartGeometry`

  Parameters: | hidePartGeo (bool) –

  New in version NX9.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## HistoryBuffer

`SimulationOptionsBuilder.``HistoryBuffer`

  Returns or sets the history buffer

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

  Getter Method

  Signature `HistoryBuffer`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HistoryBuffer`

  Parameters: | historyBuffer (int) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## InterpretContactContour

`SimulationOptionsBuilder.``InterpretContactContour`

  Returns or sets the interpret G41/42 as contact contour

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

  Getter Method

  Signature `InterpretContactContour`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InterpretContactContour`

  Parameters: | interpretContactContour (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## IpwColor

`SimulationOptionsBuilder.``IpwColor`

  Returns or sets the ipw color

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

  Getter Method

  Signature `IpwColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IpwColor`

  Parameters: | ipwColor (Id) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## IpwResolution

`SimulationOptionsBuilder.``IpwResolution`

  Returns or sets the ipw resolution

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

  Getter Method

  Signature `IpwResolution`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderResolution`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IpwResolution`

  Parameters: | ipwResolution (`NXOpen.CAM.SimulationOptionsBuilderResolution`) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## MaxAngularIncr

`SimulationOptionsBuilder.``MaxAngularIncr`

  Returns or sets the max angular incr

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

  Getter Method

  Signature `MaxAngularIncr`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxAngularIncr`

  Parameters: | maxAngularIncr (float) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## MaxLengthIncr

`SimulationOptionsBuilder.``MaxLengthIncr`

  Returns or sets the max length incr

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

  Getter Method

  Signature `MaxLengthIncr`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaxLengthIncr`

  Parameters: | maxLengthIncr (float) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## MaxTimeIncr

`SimulationOptionsBuilder.``MaxTimeIncr`

  Returns or sets the max time incr

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

  Getter Method

  Signature `MaxTimeIncr`

  Returns: |
  Return type: | float

  New in version NX10.0.2.

  License requirements: None.

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

  Setter Method

  Signature `MaxTimeIncr`

  Parameters: | maxTimeIncr (float) –

  New in version NX10.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## MinSimulationTime

`SimulationOptionsBuilder.``MinSimulationTime`

  Returns or sets the minimum simulation time

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

  Getter Method

  Signature `MinSimulationTime`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MinSimulationTime`

  Parameters: | minSimTime (float) –

  New in version NX8.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## Mrshape

`SimulationOptionsBuilder.``Mrshape`

  Returns or sets the tool shape for material removal

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

  Getter Method

  Signature `Mrshape`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderToolShapeMR`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Mrshape`

  Parameters: | toolShape (`NXOpen.CAM.SimulationOptionsBuilderToolShapeMR`) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## SaveAsPartfile

`SimulationOptionsBuilder.``SaveAsPartfile`

  Returns or sets the save as partfile

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

  Getter Method

  Signature `SaveAsPartfile`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SaveAsPartfile`

  Parameters: | saveAsComp (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## SimulationDisplay

`SimulationOptionsBuilder.``SimulationDisplay`

  Returns or sets the option to control the display update.

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

  Getter Method

  Signature `SimulationDisplay`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode`

  New in version NX10.0.2.

  License requirements: None.

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

  Setter Method

  Signature `SimulationDisplay`

  Parameters: | simulationDisplayValue (`NXOpen.CAM.SimulationOptionsBuilderSimulationDisplayMode`) –

  New in version NX10.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## StockSetting

`SimulationOptionsBuilder.``StockSetting`

  Returns or sets the stock setting

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

  Getter Method

  Signature `StockSetting`

  Returns: |
  Return type: | `NXOpen.CAM.SimulationOptionsBuilderStockType`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StockSetting`

  Parameters: | stockmode (`NXOpen.CAM.SimulationOptionsBuilderStockType`) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## StockValue

`SimulationOptionsBuilder.``StockValue`

  Returns or sets the stock value

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

  Getter Method

  Signature `StockValue`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StockValue`

  Parameters: | stock (float) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## StopOnCollision

`SimulationOptionsBuilder.``StopOnCollision`

  Returns or sets the stop on collision

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

  Getter Method

  Signature `StopOnCollision`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StopOnCollision`

  Parameters: | stopOnCollision (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## StopOnHistoryBuffer

`SimulationOptionsBuilder.``StopOnHistoryBuffer`

  Returns or sets the stop on history buffer

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

  Getter Method

  Signature `StopOnHistoryBuffer`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StopOnHistoryBuffer`

  Parameters: | stopOnHistoryBuffer (bool) – -1 = unlimited

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## StopOnLimitViolation

`SimulationOptionsBuilder.``StopOnLimitViolation`

  Returns or sets the stop on limit violation

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

  Getter Method

  Signature `StopOnLimitViolation`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StopOnLimitViolation`

  Parameters: | stopOnLimitViolation (bool) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## StopOnRapidThroughIpw

`SimulationOptionsBuilder.``StopOnRapidThroughIpw`

  Returns or sets the stop on rapid through ipw

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

  Getter Method

  Signature `StopOnRapidThroughIpw`

  Returns: |
  Return type: | bool

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `StopOnRapidThroughIpw`

  Parameters: | stopOnRapidThroughIpw (bool) –

  New in version NX9.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## ToolTraceSize

`SimulationOptionsBuilder.``ToolTraceSize`

  Returns or sets the tool trace size

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

  Getter Method

  Signature `ToolTraceSize`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToolTraceSize`

  Parameters: | toolTraceSize (int) – -1 = unlimited

  New in version NX9.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

## TranslucencyValue

`SimulationOptionsBuilder.``TranslucencyValue`

  Returns or sets the translucency value

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

  Getter Method

  Signature `TranslucencyValue`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TranslucencyValue`

  Parameters: | translucencyValue (int) –

  New in version NX6.0.0.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)

# Method Detail

## Validate

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