NXOpen .NET Reference  12.0.0
Public Member Functions | List of all members
NXOpen.Motion.MotionSolution Class Reference

Represents a solution More...

Inheritance diagram for NXOpen.Motion.MotionSolution:
NXOpen.NXObject NXOpen.INXObject NXOpen.Motion.AdvancedSolution

Public Member Functions

unsafe void SolveNormalRunSolution ()
 Solve normal run solution. More...
 
unsafe void ExportMotionHostCosimMfiles ()
 Export motion host cosim mfiles More...
 
unsafe void EditRunsimulinkMfile ()
 Edit runsimulink mfile More...
 
unsafe void ExportSimulinkHostCosimMfiles ()
 Export simulink host cosim mfiles More...
 
unsafe int CalculateGrueblerCount ()
 Calculate gruebler count of motion solution More...
 
unsafe void AddObject (NXOpen.NXObject @object)
 Adds a solution solved object to a solution More...
 
unsafe void RemoveObject (NXOpen.NXObject @object)
 Removes a solution solved object from a solution More...
 
unsafe void AddSuppressedObject (NXOpen.NXObject @object)
 Adds a suppressed object to a solution More...
 
unsafe void RemoveSuppressedObject (NXOpen.NXObject @object)
 Removes a suppressed object from a solution More...
 
unsafe void RemoveSuppressedObject (NXOpen.NXObject motionObject, bool forceOk)
 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. More...
 
unsafe string GetName ()
 Get name More...
 
unsafe void SetName (string solutionName, bool renameResultFile)
 Set name More...
 
unsafe
NXOpen.Motion.AnimationControl 
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 More...
 
unsafe
NXOpen.Motion.ArticulationControl 
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 More...
 
unsafe
NXOpen.Motion.SpreadsheetRunControl 
GetSpreadsheetRunControl (string spreadsheetName)
 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 More...
 
unsafe
NXOpen.Motion.LoadTransferControl 
GetLoadTransferControl ()
 Get NXOpen.Motion.LoadTransferControl object, must be called before any other load transfer control operation. More...
 
unsafe
NXOpen.Motion.PostToolsControl 
GetPostToolsControl ()
 Get NXOpen.Motion.PostToolsControl object, must be called before any other post tools control operation. More...
 
unsafe void GetGraphObjectResult (NXOpen.Motion.Graph graph, out double[] resultPoints, out NXOpen.Unit unit)
 Get the result of the graph object More...
 
unsafe void SaveGraphObjectToSpreadsheet (NXOpen.Motion.Graph xGraph, NXOpen.Motion.Graph[] yGraphs, bool showGraph, bool writeTime)
 Save the result of graph to spreadsheet More...
 
unsafe void SaveGraphObjectToAfu (string fileName, NXOpen.Motion.Graph xGraph, NXOpen.Motion.Graph yGraph)
 Save the result of graph to afu file More...
 
unsafe void LoadResult ()
 Load result More...
 
unsafe void ExportSolverInputFile ()
 Export solver input file for a solution More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Detailed Description

Represents a solution

To create or edit an instance of this class, use NXOpen.Motion.MotionSolutionBuilder

Created in NX5.0.0

Member Function Documentation

unsafe void NXOpen.Motion.MotionSolution.AddObject ( NXOpen.NXObject object)

Adds a solution solved object to a solution

Created in NX7.5.0

Deprecated in NX12.0.0. Use NXOpen.Motion.MotionSolution.RemoveSuppressedObject

License requirements: mechanisms ("MECHANISMS")

Parameters
objectThe solution solved object
unsafe void NXOpen.Motion.MotionSolution.AddSuppressedObject ( NXOpen.NXObject object)

Adds a suppressed object to a solution

Created in NX8.5.0

License requirements: mechanisms ("MECHANISMS")

Parameters
objectThe solution suppressed object
unsafe int NXOpen.Motion.MotionSolution.CalculateGrueblerCount ( )

Calculate gruebler count of motion solution

Created in NX7.5.0

License requirements: mechanisms ("MECHANISMS")

Returns
The gruebler count
unsafe void NXOpen.Motion.MotionSolution.EditRunsimulinkMfile ( )

Edit runsimulink mfile

Created in NX7.5.0

License requirements: nx_motion_cosim ("NX Motion CoSimulation")

unsafe void NXOpen.Motion.MotionSolution.ExportMotionHostCosimMfiles ( )

Export motion host cosim mfiles

Created in NX7.5.0

License requirements: nx_motion_cosim ("NX Motion CoSimulation")

unsafe void NXOpen.Motion.MotionSolution.ExportSimulinkHostCosimMfiles ( )

Export simulink host cosim mfiles

Created in NX7.5.0

License requirements: nx_motion_cosim ("NX Motion CoSimulation")

unsafe void NXOpen.Motion.MotionSolution.ExportSolverInputFile ( )

Export solver input file for a solution

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.AnimationControl NXOpen.Motion.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 anymore

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
The NXOpen.Motion.AnimationControl object
unsafe NXOpen.Motion.ArticulationControl NXOpen.Motion.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 anymore

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
The NXOpen.Motion.ArticulationControl object
unsafe void NXOpen.Motion.MotionSolution.GetGraphObjectResult ( NXOpen.Motion.Graph  graph,
out double[]  resultPoints,
out NXOpen.Unit  unit 
)

Get the result of the graph object

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
graph
resultPointsNeed to free it
unit
unsafe NXOpen.Motion.LoadTransferControl NXOpen.Motion.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.

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
The NXOpen.Motion.LoadTransferControl object
unsafe string NXOpen.Motion.MotionSolution.GetName ( )

Get name

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
unsafe NXOpen.Motion.PostToolsControl NXOpen.Motion.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.

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
The NXOpen.Motion.PostToolsControl object
unsafe NXOpen.Motion.SpreadsheetRunControl NXOpen.Motion.MotionSolution.GetSpreadsheetRunControl ( string  spreadsheetName)

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

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
spreadsheetName
Returns
The NXOpen.Motion.SpreadsheetRunControl object
unsafe void NXOpen.Motion.MotionSolution.LoadResult ( )

Load result

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.MotionSolution.RemoveObject ( NXOpen.NXObject object)

Removes a solution solved object from a solution

Created in NX7.5.0

Deprecated in NX12.0.0. Use NXOpen.Motion.MotionSolution.AddSuppressedObject

License requirements: mechanisms ("MECHANISMS")

Parameters
objectThe solution solved object
unsafe void NXOpen.Motion.MotionSolution.RemoveSuppressedObject ( NXOpen.NXObject object)

Removes a suppressed object from a solution

Created in NX8.5.0

License requirements: mechanisms ("MECHANISMS")

Parameters
objectThe solution suppressed object
unsafe void NXOpen.Motion.MotionSolution.RemoveSuppressedObject ( NXOpen.NXObject  motionObject,
bool  forceOk 
)

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.

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
motionObjectThe solution suppressed object
forceOkif true, skips verbosity when 2 conflicts object found and allow activation
unsafe void NXOpen.Motion.MotionSolution.SaveGraphObjectToAfu ( string  fileName,
NXOpen.Motion.Graph  xGraph,
NXOpen.Motion.Graph  yGraph 
)

Save the result of graph to afu file

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
fileName
xGraph
yGraph
unsafe void NXOpen.Motion.MotionSolution.SaveGraphObjectToSpreadsheet ( NXOpen.Motion.Graph  xGraph,
NXOpen.Motion.Graph[]  yGraphs,
bool  showGraph,
bool  writeTime 
)

Save the result of graph to spreadsheet

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
xGraph
yGraphs
showGraph
writeTime
unsafe void NXOpen.Motion.MotionSolution.SetName ( string  solutionName,
bool  renameResultFile 
)

Set name

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
solutionName
renameResultFileif true, rename both result file and solution, otherwise, rename solution only
unsafe void NXOpen.Motion.MotionSolution.SolveNormalRunSolution ( )

Solve normal run solution.

If motion has not been initialized, call NXOpen.Motion.MotionSession.InitializeSimulation before solving.

Created in NX6.0.0

License requirements: mechanisms ("MECHANISMS")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.