SpreadsheetRunControl Class

class NXOpen.Motion.SpreadsheetRunControl

Bases: NXOpen.Motion.PostControl

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
IsOccurrence	Returns whether this object is an occurrence or not.
JointsLimits	Returns or sets the spreadsheet run joint limits setting
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
PlayMode	Returns or sets the spreadsheet run play mode
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.

Methods

Method	Description
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
Finish	SpreadsheetRun finish
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
QuitSpreadsheet	Quit spreadsheet
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
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

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

Parameters:delay (int) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

IsOccurrence

SpreadsheetRunControl.IsOccurrence

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

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

Parameters:jointLimits (bool) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

JournalIdentifier

SpreadsheetRunControl.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

SpreadsheetRunControl.Name

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

SpreadsheetRunControl.OwningComponent

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

SpreadsheetRunControl.OwningPart

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

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

Parameters:mode (int) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Prototype

SpreadsheetRunControl.Prototype

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

FindObject

SpreadsheetRunControl.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Finish

SpreadsheetRunControl.Finish

SpreadsheetRun finish

Signature Finish()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Print

SpreadsheetRunControl.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

QuitSpreadsheet

SpreadsheetRunControl.QuitSpreadsheet

Quit spreadsheet

Signature QuitSpreadsheet()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

SetName

SpreadsheetRunControl.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

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”)