FeatureReplayBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FeatureReplayBuilder Class

class `NXOpen.Features.``FeatureReplayBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.FeatureReplayBuilder` builder.

  `NXOpen.Features.FeatureReplayBuilder` is used to control the feature replay of a part. Using this class, one can make the first feature or the last feature current, and step through the features by making the next feature or previous feature current. This class also allows stepping to the next boolean feature or automatically replay to a given feature. If the feature to be replayed to, is more than the current feature, one can specify a delay (time interval in seconds) between the replay of each of the features to observe the part construction with interactive NX session. When interactive NX session is not running, there will be no display of objects / current features. To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateFeatureReplayBuilder()`

  Default values.

  Property | Value
  --- | ---
  ReplayTimestampNumber | 0
  SecondsBetweenSteps | 0

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
ReplayTimestampNumber | Returns or sets the replay timestamp number of feature.
SecondsBetweenSteps | Returns or sets the delay in seconds between replay steps
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.
GetObject | Returns the object currently being edited by this builder.
MakeFirstCurrent | Makes the first feature of the work part current.
MakeLastCurrent | Makes the last feature of the work part current.
MakeNextBooleanCurrent | Makes the next boolean feature of the work part current.
MakeNextCurrent | Makes the next feature of the work part current.
MakePreviousCurrent | Makes the previous feature of the work part current.
Pause | Pauses feature replay.
Play | Starts feature replay.
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.

# Property Detail

## ReplayTimestampNumber

`FeatureReplayBuilder.``ReplayTimestampNumber`

  Returns or sets the replay timestamp number of feature.

  If this feature is more than the current feature, feature replay will continue to this feature showing the steps in between. If this feature is less than the current feature, this feature will be made current on next replay.

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

  Getter Method

  Signature `ReplayTimestampNumber`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

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

  Setter Method

  Signature `ReplayTimestampNumber`

  Parameters: | replayTimestampNumber (int) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SecondsBetweenSteps

`FeatureReplayBuilder.``SecondsBetweenSteps`

  Returns or sets the delay in seconds between replay steps

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

  Getter Method

  Signature `SecondsBetweenSteps`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

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

  Setter Method

  Signature `SecondsBetweenSteps`

  Parameters: | secondsBetweenSteps (float) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## MakeFirstCurrent

`FeatureReplayBuilder.``MakeFirstCurrent`

  Makes the first feature of the work part current.

  If replay is going on, it will stop.

  Signature `MakeFirstCurrent()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## MakeLastCurrent

`FeatureReplayBuilder.``MakeLastCurrent`

  Makes the last feature of the work part current.

  If replay is going on, it will stop.

  Signature `MakeLastCurrent()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## MakeNextBooleanCurrent

`FeatureReplayBuilder.``MakeNextBooleanCurrent`

  Makes the next boolean feature of the work part current.

  If replay is going on, it will stop.

  Signature `MakeNextBooleanCurrent()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## MakeNextCurrent

`FeatureReplayBuilder.``MakeNextCurrent`

  Makes the next feature of the work part current.

  If replay is going on, it will stop.

  Signature `MakeNextCurrent()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## MakePreviousCurrent

`FeatureReplayBuilder.``MakePreviousCurrent`

  Makes the previous feature of the work part current.

  If replay is going on, it will stop.

  Signature `MakePreviousCurrent()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Pause

`FeatureReplayBuilder.``Pause`

  Pauses feature replay.

  If replay is going on, it will pause.

  Signature `Pause()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Play

`FeatureReplayBuilder.``Play`

  Starts feature replay.

  If feature replay is in paused state, it will continue from the paused state. Replay will continue to the feature number as set by `NXOpen.Features.FeatureReplayBuilder.ReplayTimestampNumber`()`. If `NXOpen.Features.FeatureReplayBuilder.ReplayTimestampNumber`()` is more than the current feature, feature replay will continue to `NXOpen.Features.FeatureReplayBuilder.ReplayTimestampNumber`()` - one feature at a time and there will be a delay of `NXOpen.Features.FeatureReplayBuilder.SecondsBetweenSteps`()` seconds between replay of each feature. If `NXOpen.Features.FeatureReplayBuilder.ReplayTimestampNumber`()` is less than the current feature, feature `NXOpen.Features.FeatureReplayBuilder.ReplayTimestampNumber`()` will be made current feature and no steps are shown.

  Signature `Play()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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