NXOpen.Motion.MechatronicsBuilder Class Reference

Represents a Motion.Mechatronics builder More...

Inheritance diagram for NXOpen.Motion.MechatronicsBuilder:

Public Types
enum	Master { No, Yes }
	the element that defines if a Generic Co-Sim is master or not More...
enum	MechatronicsModelType { Amesim, Simulink, Generic, Fmi }
	The Mechatronics Type More...
enum	PurposeType { Import, Export }
	the mechatronics purpose type - possible values are Import and Export More...
enum	ReferenceObjectId { ModalFile, HeaderFile, ParameterFile }
	the enum for external file reference object id of mechatronics More...
enum	SolverCommunicationIntervalType { Constant, Variable }
	the mechatronics communication interval type - only for Amesim, Generic and FMI! - possible values are Constant and Variable More...
enum	SolverCommunicationRunType { Serial, Parallel }
	the mechatronics communication run type - only for Generic and FMI - possible values are Serial and Parallel More...
enum	SolverIntegrationType { CoSimulation, ModelExchange }
	the mechatronics integration type - possible values are ModelExchange and CoSimulation More...

Public Member Functions
unsafe NXOpen.ExternalFileReferenceAdapter	EstablishReference (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
	Establish the external reference to the given file specification. More...
unsafe NXOpen.Motion.ConfigurationParameter	GetConfigurationParameter (string inputName)
	Searches for the watch parameter by name in the active group More...
unsafe string	GetExternalFileDefinitionKey (NXOpen.ExternalFileReferenceAdapter adapter)
	Gets the file definition to use for external file adapter. More...
unsafe NXOpen.ExternalFileReferenceAdapter	GetExternalFileReferenceAdapter (int referenceObjectId)
	Returns the external file reference object. More...
unsafe NXOpen.Motion.InputPortAssociation	GetInput (string inputName)
	Retrieves an input port association from its name More...
unsafe NXOpen.Motion.OutputPortAssociation	GetOutput (string inputName)
	Retrieves an output port association from its name More...
unsafe string[]	GetParameterGroupNames ()
	Allows retrieving the list of names of available configuration parameter groups More...
unsafe NXOpen.Motion.PortVariable	GetPortVariable (string inputName)
	Searches for the watch variable by name in the active group More...
unsafe string[]	GetPortVariableGroupNames ()
	Allows retrieving the list of names of available port variables groups More...
unsafe NXOpen.Motion.InputPortAssociation	NewInputListItem ()
	Creates a new input list item including expressions More...
unsafe NXOpen.Motion.OutputPortAssociation	NewOutputListItem ()
	Creates a new output list item including expressions More...
unsafe void	ReadInterfaceFromFile (string filePath)
	Reads the input/output definition of a mechatronics element from an external file, when purpose is specified as Export. More...
unsafe void	RefreshLists ()
	Updates the list of available inputs and outputs (for both MATLAB ans Amesim models) and Configuration Parametersa and port Variables (for Amesim only) from the selected HeaderFile/ModelFile More...
unsafe void	SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
	Sets the external file reference object. More...

Properties
unsafe string	ActiveParameterGroupName [get, set]
	Returns or sets the active configuration parameters group name More...
unsafe string	ActivePortVariableGroupName [get, set]
	Returns or sets the active port variable group name More...
unsafe NXOpen.Expression	CommunicationInterval [get, set]
	Returns or sets the communication interval More...
unsafe NXOpen.Motion.MechatronicsBuilder.SolverCommunicationIntervalType	CommunicationIntervalType [get, set]
	Returns or sets the communication interval type - possible values are Constant, Variable More...
unsafe NXOpen.Motion.MechatronicsBuilder.SolverCommunicationRunType	CommunicationRunType [get, set]
	Returns or sets the run type mechatronics element for Generic and FMI - possible values are Serial, Parallel More...
unsafe NXOpen.Motion.ConfigurationParameterList	ConfigurationParametersList [get]
	Returns the configuration/watch parameters list More...
unsafe string	FunctionName [get, set]
	Returns or sets the function name for Generic and FMI More...
unsafe NXOpen.Motion.InputPortAssociationList	InputPortsList [get]
	Returns the input ports list More...
unsafe NXOpen.Motion.InputPortAssociationList	InputPortsListAmesimAndSimulink [get]
	Returns the input ports list for Amesim and Simulink More...
unsafe NXOpen.Motion.InputPortAssociationList	InputPortsListGenericAndFMI [get]
	Returns the input ports list for Generic and FMI More...
unsafe NXOpen.Motion.MechatronicsBuilder.SolverIntegrationType	IntegrationType [get, set]
	Returns or sets the integration type - possible values are CoSimulation, ModelExchange More...
unsafe NXOpen.Motion.MechatronicsBuilder.Master	IsMaster [get, set]
	Returns or sets a value that represents if a Generic Co-Sim is master - possible values Yes or No More...
unsafe NXOpen.Motion.MechatronicsBuilder.MechatronicsModelType	MechatronicsType [get, set]
	Returns or sets the mechatronics type - possible values are Simulink, Amesim, Generic or FMI More...
unsafe string	Name [get, set]
	Returns or sets the name of the element More...
unsafe int	NumSolveIterations [get, set]
	Returns or sets the number of solve iterations for Generic and FMI More...
unsafe NXOpen.Motion.OutputPortAssociationList	OutputPortsList [get]
	Returns the output ports list More...
unsafe NXOpen.Motion.OutputPortAssociationList	OutputPortsListAmesimAndSimulink [get]
	Returns the output ports list for Amesim and Simulink More...
unsafe NXOpen.Motion.OutputPortAssociationList	OutputPortsListGenericAndFMI [get]
	Returns the output ports list for Generic and FMI More...
unsafe NXOpen.Motion.PortVariableList	PortVariablesList [get]
	Returns the watch variables list More...
unsafe NXOpen.Motion.MechatronicsBuilder.PurposeType	Purpose [get, set]
	Returns or sets the purpose of the mechatronics element - possible values are Import, Export More...
Properties inherited from NXOpen.Motion.MotionBuilder
unsafe double	DisplayScale [get, set]
	Returns or sets the icon display scale More...
unsafe string	GroupName [get, set]
	Returns or sets the group name More...
unsafe NXOpen.Motion.MotionObject.GroupType	GroupType [get, set]
	Returns or sets the group type More...
Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder [get]
	Returns the preview builder subobject. More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a Motion.Mechatronics builder

To create a new instance of this class, use NXOpen.Motion.MechatronicsCollection.CreateMechatronicsBuilder

Default values.

Property	Value
CommunicationInterval.Value	0.01 (millimeters part), 0.01 (inches part)
CommunicationIntervalType	Constant
IntegrationType	CoSimulation
MechatronicsType	Amesim
Purpose	Import

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.Motion.MechatronicsBuilder.Master

the element that defines if a Generic Co-Sim is master or not

Enumerator
No
Yes

enum NXOpen.Motion.MechatronicsBuilder.MechatronicsModelType

The Mechatronics Type

Possible values are Simulink or Amesim Warning: Starting with Simcenter 2019.1, the Matlab option is renamed to Simulink

Enumerator
Amesim
Simulink
Generic
Fmi

enum NXOpen.Motion.MechatronicsBuilder.PurposeType

the mechatronics purpose type - possible values are Import and Export

Enumerator
Import
Export

enum NXOpen.Motion.MechatronicsBuilder.ReferenceObjectId

the enum for external file reference object id of mechatronics

Enumerator
ModalFile
HeaderFile
ParameterFile

enum NXOpen.Motion.MechatronicsBuilder.SolverCommunicationIntervalType

the mechatronics communication interval type - only for Amesim, Generic and FMI! - possible values are Constant and Variable

Enumerator
Constant
Variable

enum NXOpen.Motion.MechatronicsBuilder.SolverCommunicationRunType

the mechatronics communication run type - only for Generic and FMI - possible values are Serial and Parallel

Enumerator
Serial
Parallel

enum NXOpen.Motion.MechatronicsBuilder.SolverIntegrationType

the mechatronics integration type - possible values are ModelExchange and CoSimulation

Enumerator
CoSimulation
ModelExchange

Member Function Documentation

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.MechatronicsBuilder.EstablishReference ( int  referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type  referenceType, string  externalFileSpec  )

inline

Establish the external reference to the given file specification.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId	the unique identifier to use for this reference if referencer has multiple external references
referenceType	the kind of reference to establish
externalFileSpec	the external file specification.

Returns

external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.Motion.ConfigurationParameter NXOpen.Motion.MechatronicsBuilder.GetConfigurationParameter ( string  inputName )

inline

Searches for the watch parameter by name in the active group

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

inputName

Returns

unsafe string NXOpen.Motion.MechatronicsBuilder.GetExternalFileDefinitionKey ( NXOpen.ExternalFileReferenceAdapter  adapter )

inline

Gets the file definition to use for external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters

adapter

external file reference object

Returns

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.MechatronicsBuilder.GetExternalFileReferenceAdapter ( int  referenceObjectId )

inline

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId

the unique identifier of the external reference required in case where referencer has multiple external references

Returns

external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.Motion.InputPortAssociation NXOpen.Motion.MechatronicsBuilder.GetInput ( string  inputName )

inline

Retrieves an input port association from its name

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

inputName

Returns

unsafe NXOpen.Motion.OutputPortAssociation NXOpen.Motion.MechatronicsBuilder.GetOutput ( string  inputName )

inline

Retrieves an output port association from its name

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

inputName

Returns

unsafe string [] NXOpen.Motion.MechatronicsBuilder.GetParameterGroupNames ( )

inline

Allows retrieving the list of names of available configuration parameter groups

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns

unsafe NXOpen.Motion.PortVariable NXOpen.Motion.MechatronicsBuilder.GetPortVariable ( string  inputName )

inline

Searches for the watch variable by name in the active group

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

inputName

Returns

unsafe string [] NXOpen.Motion.MechatronicsBuilder.GetPortVariableGroupNames ( )

inline

Allows retrieving the list of names of available port variables groups

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns

unsafe NXOpen.Motion.InputPortAssociation NXOpen.Motion.MechatronicsBuilder.NewInputListItem ( )

inline

Creates a new input list item including expressions

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns

unsafe NXOpen.Motion.OutputPortAssociation NXOpen.Motion.MechatronicsBuilder.NewOutputListItem ( )

inline

Creates a new output list item including expressions

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns

unsafe void NXOpen.Motion.MechatronicsBuilder.ReadInterfaceFromFile ( string  filePath )

inline

Reads the input/output definition of a mechatronics element from an external file, when purpose is specified as Export.

Allowed file types are .txt, .csv, and Excel files

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

filePath

unsafe void NXOpen.Motion.MechatronicsBuilder.RefreshLists ( )

inline

Updates the list of available inputs and outputs (for both MATLAB ans Amesim models) and Configuration Parametersa and port Variables (for Amesim only) from the selected HeaderFile/ModelFile

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.MechatronicsBuilder.SetExternalFileReferenceAdapter ( int  referenceObjectId, NXOpen.ExternalFileReferenceAdapter  adapter  )

inline

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId	the unique identifier of the external reference required in case where referencer has multiple external references
adapter	external file reference object

Implements NXOpen.IExternalFileReferencer.

Property Documentation

unsafe string NXOpen.Motion.MechatronicsBuilder.ActiveParameterGroupName

getset

Returns or sets the active configuration parameters group name

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.MechatronicsBuilder.ActivePortVariableGroupName

getset

Returns or sets the active port variable group name

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.MechatronicsBuilder.CommunicationInterval

getset

Returns or sets the communication interval

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MechatronicsBuilder.SolverCommunicationIntervalType NXOpen.Motion.MechatronicsBuilder.CommunicationIntervalType

getset

Returns or sets the communication interval type - possible values are Constant, Variable

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MechatronicsBuilder.SolverCommunicationRunType NXOpen.Motion.MechatronicsBuilder.CommunicationRunType

getset

Returns or sets the run type mechatronics element for Generic and FMI - possible values are Serial, Parallel

Created in NX1872.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.ConfigurationParameterList NXOpen.Motion.MechatronicsBuilder.ConfigurationParametersList

get

Returns the configuration/watch parameters list

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.MechatronicsBuilder.FunctionName

getset

Returns or sets the function name for Generic and FMI

Created in NX1872.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.InputPortAssociationList NXOpen.Motion.MechatronicsBuilder.InputPortsList

get

Returns the input ports list

Created in NX11.0.0

Deprecated in NX1872.0.0. Use NXOpen.Motion.MechatronicsBuilder.InputPortsListAmesimAndSimulink

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.InputPortAssociationList NXOpen.Motion.MechatronicsBuilder.InputPortsListAmesimAndSimulink

get

Returns the input ports list for Amesim and Simulink

Created in NX1872.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.InputPortAssociationList NXOpen.Motion.MechatronicsBuilder.InputPortsListGenericAndFMI

get

Returns the input ports list for Generic and FMI

Created in NX1872.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MechatronicsBuilder.SolverIntegrationType NXOpen.Motion.MechatronicsBuilder.IntegrationType

getset

Returns or sets the integration type - possible values are CoSimulation, ModelExchange

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MechatronicsBuilder.Master NXOpen.Motion.MechatronicsBuilder.IsMaster

getset

Returns or sets a value that represents if a Generic Co-Sim is master - possible values Yes or No

Created in NX1872.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MechatronicsBuilder.MechatronicsModelType NXOpen.Motion.MechatronicsBuilder.MechatronicsType

getset

Returns or sets the mechatronics type - possible values are Simulink, Amesim, Generic or FMI

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.MechatronicsBuilder.Name

getset

Returns or sets the name of the element

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe int NXOpen.Motion.MechatronicsBuilder.NumSolveIterations

getset

Returns or sets the number of solve iterations for Generic and FMI

Created in NX1872.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.OutputPortAssociationList NXOpen.Motion.MechatronicsBuilder.OutputPortsList

get

Returns the output ports list

Created in NX11.0.0

Deprecated in NX1872.0.0. Use NXOpen.Motion.MechatronicsBuilder.OutputPortsListAmesimAndSimulink

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.OutputPortAssociationList NXOpen.Motion.MechatronicsBuilder.OutputPortsListAmesimAndSimulink

get

Returns the output ports list for Amesim and Simulink

Created in NX1872.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.OutputPortAssociationList NXOpen.Motion.MechatronicsBuilder.OutputPortsListGenericAndFMI

get

Returns the output ports list for Generic and FMI

Created in NX1872.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.PortVariableList NXOpen.Motion.MechatronicsBuilder.PortVariablesList

get

Returns the watch variables list

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MechatronicsBuilder.PurposeType NXOpen.Motion.MechatronicsBuilder.Purpose

getset

Returns or sets the purpose of the mechatronics element - possible values are Import, Export

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

---

The documentation for this class was generated from the following file:

• Motion_MechatronicsBuilder.cs