NcProgramManagerBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NcProgramManagerBuilder Class

class `NXOpen.SIM.``NcProgramManagerBuilder`

  Bases: `NXOpen.Builder`

  Represents a NcProgramManagerBuilder builder object.

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

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
ActivateAllBreakpoints | Activate all deactivated breakpoints.
ActivateBreakpoint | Activate a breakpoint in a program line.
AddBreakpoint | Add a breakpoint to a program line.
AddMatchingBreakpoint | Add a matching breakpoint to program manager.
Commit | Commits any edits that have been applied to the builder.
DeactivateAllBreakpoints | Deactivate all active breakpoints.
DeactivateBreakpoint | Deactivate a breakpoint in a program line.
DeleteAllBreakpoints | Delete all breakpoints.
DeleteBreakpoint | Remove a breakpoint from a program line.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetBreakpoints | Get all breakpoints.
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.

# Method Detail

## ActivateAllBreakpoints

`NcProgramManagerBuilder.``ActivateAllBreakpoints`

  Activate all deactivated breakpoints.

  Signature `ActivateAllBreakpoints()`

  New in version NX11.0.0.

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

## ActivateBreakpoint

`NcProgramManagerBuilder.``ActivateBreakpoint`

  Activate a breakpoint in a program line.

  Signature `ActivateBreakpoint(program, lineNumber)`

  Parameters:

  - program (`NXOpen.SIM.NcProgram`) – The program in which the breakpoint is to be activated.
  - lineNumber (int) – The line number of the breakpoint (zero based).

  New in version NX11.0.0.

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

## AddBreakpoint

`NcProgramManagerBuilder.``AddBreakpoint`

  Add a breakpoint to a program line.

  Signature `AddBreakpoint(program, lineNumber)`

  Parameters:

  - program (`NXOpen.SIM.NcProgram`) – The program in which the breakpoint is to be added.
  - lineNumber (int) – The line number of the breakpoint (zero based).

  New in version NX11.0.0.

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

## AddMatchingBreakpoint

`NcProgramManagerBuilder.``AddMatchingBreakpoint`

  Add a matching breakpoint to program manager.

  Signature `AddMatchingBreakpoint(condition)`

  Parameters: | condition (str) – The condition for the line and program independent breakpoint to be added.

  New in version NX11.0.0.

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

## DeactivateAllBreakpoints

`NcProgramManagerBuilder.``DeactivateAllBreakpoints`

  Deactivate all active breakpoints.

  Signature `DeactivateAllBreakpoints()`

  New in version NX11.0.0.

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

## DeactivateBreakpoint

`NcProgramManagerBuilder.``DeactivateBreakpoint`

  Deactivate a breakpoint in a program line.

  Signature `DeactivateBreakpoint(program, lineNumber)`

  Parameters:

  - program (`NXOpen.SIM.NcProgram`) – The program in which the breakpoint is to be deactivated.
  - lineNumber (int) – The line number of the breakpoint (zero based).

  New in version NX11.0.0.

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

## DeleteAllBreakpoints

`NcProgramManagerBuilder.``DeleteAllBreakpoints`

  Delete all breakpoints.

  Signature `DeleteAllBreakpoints()`

  New in version NX11.0.0.

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

## DeleteBreakpoint

`NcProgramManagerBuilder.``DeleteBreakpoint`

  Remove a breakpoint from a program line.

  Signature `DeleteBreakpoint(program, lineNumber)`

  Parameters:

  - program (`NXOpen.SIM.NcProgram`) – The program in which the breakpoint is to be deleted
  - lineNumber (int) – The line number of the breakpoint (zero based).

  New in version NX11.0.0.

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

## GetBreakpoints

`NcProgramManagerBuilder.``GetBreakpoints`

  Get all breakpoints.

  Signature `GetBreakpoints()`

  Returns: | array of all breakpoints
  Return type: | list of `NXOpen.SIM.Breakpoint`

  New in version NX11.0.0.

  License requirements: None.

## Validate

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