SpreadsheetRunControl Class

class NXOpen.Motion.SpreadsheetRunControl

Bases: NXOpen.TaggedObject

Represents the NXOpen.Motion.SpreadsheetRunControl

An instance of this class can not be obtained

New in version NX9.0.0.

Properties

Property Description
ActiveView Returns or sets the active view
Delay Returns or sets the spreadsheet run delay
JointsLimits Returns or sets the spreadsheet run joint limits setting
PlayMode Returns or sets the spreadsheet run play mode
Tag Returns the Tag for this object.

Methods

Method Description
Finish SpreadsheetRun finish
QuitSpreadsheet Quit spreadsheet
Solve SpreadsheetRun solve function
StepBackward SpreadsheetRun step backward
StepForward SpreadsheetRun step forward
StepTo SpreadsheetRun step to special step
StepToAssemblyPosition SpreadsheetRun to assembly position
StepToDesignPosition SpreadsheetRun to design position
Stop SpreadsheetRun stop
UpdateFromSpreadsheet SpreadsheetRun update from spreadsheet

Property Detail

ActiveView

SpreadsheetRunControl.ActiveView

Returns or sets the active view

-------------------------------------

Getter Method

Signature ActiveView()

Returns:The spreadsheet run active view
Return type:NXOpen.Motion.ActiveView

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ActiveView(activeView)

Parameters:activeView (NXOpen.Motion.ActiveView) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Delay

SpreadsheetRunControl.Delay

Returns or sets the spreadsheet run delay

-------------------------------------

Getter Method

Signature Delay()

Returns:The spreadsheet run delay
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Delay(delay)

Parameters:delay (int) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

JointsLimits

SpreadsheetRunControl.JointsLimits

Returns or sets the spreadsheet run joint limits setting

-------------------------------------

Getter Method

Signature JointsLimits()

Returns:The joint limits on/off flag setting
Return type:bool

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature JointsLimits(jointLimits)

Parameters:jointLimits (bool) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

PlayMode

SpreadsheetRunControl.PlayMode

Returns or sets the spreadsheet run play mode

-------------------------------------

Getter Method

Signature PlayMode()

Returns:The spreadsheet run play mode
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature PlayMode(mode)

Parameters:mode (int) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Finish

SpreadsheetRunControl.Finish

SpreadsheetRun finish

Signature Finish()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

QuitSpreadsheet

SpreadsheetRunControl.QuitSpreadsheet

Quit spreadsheet

Signature QuitSpreadsheet()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Solve

SpreadsheetRunControl.Solve

SpreadsheetRun solve function

Signature Solve()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepBackward

SpreadsheetRunControl.StepBackward

SpreadsheetRun step backward

Signature StepBackward()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepForward

SpreadsheetRunControl.StepForward

SpreadsheetRun step forward

Signature StepForward()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepTo

SpreadsheetRunControl.StepTo

SpreadsheetRun step to special step

Signature StepTo(step)

Parameters:step (int) – This is the step number in spreadsheet. If the step number = -1, the system will use the current position in spreadsheet.

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepToAssemblyPosition

SpreadsheetRunControl.StepToAssemblyPosition

SpreadsheetRun to assembly position

Signature StepToAssemblyPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepToDesignPosition

SpreadsheetRunControl.StepToDesignPosition

SpreadsheetRun to design position

Signature StepToDesignPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Stop

SpreadsheetRunControl.Stop

SpreadsheetRun stop

Signature Stop()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

UpdateFromSpreadsheet

SpreadsheetRunControl.UpdateFromSpreadsheet

SpreadsheetRun update from spreadsheet

Signature UpdateFromSpreadsheet()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)