MotionSolution Class¶
-
class
NXOpen.Motion.
MotionSolution
¶ Bases:
NXOpen.NXObject
Represents a solution
To create or edit an instance of this class, use
NXOpen.Motion.MotionSolutionBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
IsOccurrence | Returns whether this object is an occurrence or not. |
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 |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddObject | Adds a solution solved object to a solution |
AddSuppressedObject | Adds a suppressed object to a solution |
CalculateGrueblerCount | Calculate gruebler count of motion solution |
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 |
EditRunsimulinkMfile | Edit runsimulink mfile |
ExportMotionHostCosimMfiles | Export motion host cosim mfiles |
ExportSimulinkHostCosimMfiles | Export simulink host cosim mfiles |
ExportSolverInputFile | Export solver input file for a solution |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAnimationControl | Get NXOpen.Motion.AnimationControl object, must be called before any other animation control operation, and the finish API must be call if not use anymore |
GetArticulationControl | Get NXOpen.Motion.ArticulationControl object, must be called before any other articulation control operation, and the finish API must be call if not use anymore |
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. |
GetGraphObjectResult | Get the result of the graph object |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetLoadTransferControl | Get NXOpen.Motion.LoadTransferControl object, must be called before any other load transfer control operation. |
GetName | Get name |
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. |
GetPostToolsControl | Get NXOpen.Motion.PostToolsControl object, must be called before any other post tools control operation. |
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. |
GetSpreadsheetRunControl | Get NXOpen.Motion.SpreadsheetRunControl object, must be called before any other spreadsheet run control operation, and the finish API must be call if not use anymore |
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 |
LoadResult | Load result |
Prints a representation of this object to the system log file. | |
RemoveObject | Removes a solution solved object from a solution |
RemoveSuppressedObject | Removes a suppressed object from a solution |
SaveGraphObjectToAfu | Save the result of graph to afu file |
SaveGraphObjectToSpreadsheet | Save the result of graph to spreadsheet |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetName | Set name |
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. |
SolveNormalRunSolution | Solve normal run solution. |
Property Detail¶
IsOccurrence¶
-
MotionSolution.
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.
JournalIdentifier¶
-
MotionSolution.
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¶
-
MotionSolution.
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¶
-
MotionSolution.
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¶
-
MotionSolution.
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.
Prototype¶
-
MotionSolution.
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¶
AddObject¶
-
MotionSolution.
AddObject
¶ Adds a solution solved object to a solution
Signature
AddObject(object)
Parameters: object ( NXOpen.NXObject
) – The solution solved objectNew in version NX7.5.0.
Deprecated since version NX12.0.0: Use
NXOpen.Motion.MotionSolution.RemoveSuppressedObject()
License requirements: mechanisms (“MECHANISMS”)
AddSuppressedObject¶
-
MotionSolution.
AddSuppressedObject
¶ Adds a suppressed object to a solution
Signature
AddSuppressedObject(object)
Parameters: object ( NXOpen.NXObject
) – The solution suppressed objectNew in version NX8.5.0.
License requirements: mechanisms (“MECHANISMS”)
CalculateGrueblerCount¶
-
MotionSolution.
CalculateGrueblerCount
¶ Calculate gruebler count of motion solution
Signature
CalculateGrueblerCount()
Returns: The gruebler count Return type: int New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
EditRunsimulinkMfile¶
-
MotionSolution.
EditRunsimulinkMfile
¶ Edit runsimulink mfile
Signature
EditRunsimulinkMfile()
New in version NX7.5.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
ExportMotionHostCosimMfiles¶
-
MotionSolution.
ExportMotionHostCosimMfiles
¶ Export motion host cosim mfiles
Signature
ExportMotionHostCosimMfiles()
New in version NX7.5.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
ExportSimulinkHostCosimMfiles¶
-
MotionSolution.
ExportSimulinkHostCosimMfiles
¶ Export simulink host cosim mfiles
Signature
ExportSimulinkHostCosimMfiles()
New in version NX7.5.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
ExportSolverInputFile¶
-
MotionSolution.
ExportSolverInputFile
¶ Export solver input file for a solution
Signature
ExportSolverInputFile()
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
FindObject¶
-
MotionSolution.
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.
GetAnimationControl¶
-
MotionSolution.
GetAnimationControl
¶ Get
NXOpen.Motion.AnimationControl
object, must be called before any other animation control operation, and the finish API must be call if not use anymoreSignature
GetAnimationControl()
Returns: The NXOpen.Motion.AnimationControl
objectReturn type: NXOpen.Motion.AnimationControl
New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetArticulationControl¶
-
MotionSolution.
GetArticulationControl
¶ Get
NXOpen.Motion.ArticulationControl
object, must be called before any other articulation control operation, and the finish API must be call if not use anymoreSignature
GetArticulationControl()
Returns: The NXOpen.Motion.ArticulationControl
objectReturn type: NXOpen.Motion.ArticulationControl
New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetGraphObjectResult¶
-
MotionSolution.
GetGraphObjectResult
¶ Get the result of the graph object
Signature
GetGraphObjectResult(graph)
Parameters: graph ( NXOpen.Motion.Graph
) –Returns: a tuple Return type: A tuple consisting of (resultPoints, unit). resultPoints is a list of float. Need to free itunit is a NXOpen.Unit
.New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetLoadTransferControl¶
-
MotionSolution.
GetLoadTransferControl
¶ Get
NXOpen.Motion.LoadTransferControl
object, must be called before any other load transfer control operation.NXOpen.Motion.LoadTransferControl.Finish()
must be called after use is over.Signature
GetLoadTransferControl()
Returns: The NXOpen.Motion.LoadTransferControl
objectReturn type: NXOpen.Motion.LoadTransferControl
New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetName¶
-
MotionSolution.
GetName
¶ Get name
Signature
GetName()
Returns: Return type: str New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetPostToolsControl¶
-
MotionSolution.
GetPostToolsControl
¶ Get
NXOpen.Motion.PostToolsControl
object, must be called before any other post tools control operation.NXOpen.Motion.PostToolsControl.Finish()
must be called after use is over.Signature
GetPostToolsControl()
Returns: The NXOpen.Motion.PostToolsControl
objectReturn type: NXOpen.Motion.PostToolsControl
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetSpreadsheetRunControl¶
-
MotionSolution.
GetSpreadsheetRunControl
¶ Get
NXOpen.Motion.SpreadsheetRunControl
object, must be called before any other spreadsheet run control operation, and the finish API must be call if not use anymoreSignature
GetSpreadsheetRunControl(spreadsheetName)
Parameters: spreadsheetName (str) – Returns: The NXOpen.Motion.SpreadsheetRunControl
objectReturn type: NXOpen.Motion.SpreadsheetRunControl
New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
LoadResult¶
-
MotionSolution.
LoadResult
¶ Load result
Signature
LoadResult()
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Print¶
-
MotionSolution.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveObject¶
-
MotionSolution.
RemoveObject
¶ Removes a solution solved object from a solution
Signature
RemoveObject(object)
Parameters: object ( NXOpen.NXObject
) – The solution solved objectNew in version NX7.5.0.
Deprecated since version NX12.0.0: Use
NXOpen.Motion.MotionSolution.AddSuppressedObject()
License requirements: mechanisms (“MECHANISMS”)
RemoveSuppressedObject¶
-
MotionSolution.
RemoveSuppressedObject
¶ Overloaded method RemoveSuppressedObject
RemoveSuppressedObject(object)
RemoveSuppressedObject(motionObject, forceOk)
-------------------------------------
Removes a suppressed object from a solution
Signature
RemoveSuppressedObject(object)
Parameters: object ( NXOpen.NXObject
) – The solution suppressed objectNew in version NX8.5.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Removes a suppressed object from a solution Takes a flag that can be use to force ok to the dialog that could arise when conflict objects are found: e.g. 2 active drivers on the same joint. Using this flag as true might leave conflict objects active and an incosistent model.
Signature
RemoveSuppressedObject(motionObject, forceOk)
Parameters: - motionObject (
NXOpen.NXObject
) – The solution suppressed object - forceOk (bool) – if true, skips verbosity when 2 conflicts object found and allow activation
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
SaveGraphObjectToAfu¶
-
MotionSolution.
SaveGraphObjectToAfu
¶ Save the result of graph to afu file
Signature
SaveGraphObjectToAfu(fileName, xGraph, yGraph)
Parameters: - fileName (str) –
- xGraph (
NXOpen.Motion.Graph
) – - yGraph (
NXOpen.Motion.Graph
) –
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SaveGraphObjectToSpreadsheet¶
-
MotionSolution.
SaveGraphObjectToSpreadsheet
¶ Save the result of graph to spreadsheet
Signature
SaveGraphObjectToSpreadsheet(xGraph, yGraphs, showGraph, writeTime)
Parameters: - xGraph (
NXOpen.Motion.Graph
) – - yGraphs (list of
NXOpen.Motion.Graph
) – - showGraph (bool) –
- writeTime (bool) –
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
- xGraph (
SetName¶
-
MotionSolution.
SetName
¶ Set name
Signature
SetName(solutionName, renameResultFile)
Parameters: - solutionName (str) –
- renameResultFile (bool) – if true, rename both result file and solution, otherwise, rename solution only
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
SolveNormalRunSolution¶
-
MotionSolution.
SolveNormalRunSolution
¶ Solve normal run solution.
If motion has not been initialized, call
NXOpen.Motion.MotionSession.InitializeSimulation()
before solving.Signature
SolveNormalRunSolution()
New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)