Represents a Motion.Mechatronics builder More...

Inheritance diagram for NXOpen.Motion.MechatronicsBuilder:

Public Types
enum	MechatronicsModelType { Amesim, Matlab }
	the mechatronics type - possible values are Matlab or Amesim More...

enum	PurposeType { Import, Export }
	the mechatronics purpose type - possible values are Import and Export More...

enum	SolverIntegrationType { CoSimulation, ModelExchange }
	the mechatronics integration type - possible values are ModelExchange and CoSimulation More...

enum	SolverCommunicationIntervalType { Constant, Variable }
	the mechatronics communication interval type - only for Amesim! - possible values are Constant and Variable More...

Public Member Functions
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 string[]	GetParameterGroupNames ()
	Allows retrieving the list of names of available configuration parameter groups More...

unsafe string[]	GetPortVariableGroupNames ()
	Allows retrieving the list of names of available port variables groups 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 NXOpen.Motion.PortVariable	GetPortVariable (string inputName)
	Searches for the watch variable by name in the active group More...

unsafe NXOpen.Motion.ConfigurationParameter	GetConfigurationParameter (string inputName)
	Searches for the watch parameter by name in the active group More...

unsafe NXOpen.Motion.OutputPortAssociation	NewOutputListItem ()
	Creates a new output list item including expressions More...

unsafe NXOpen.Motion.InputPortAssociation	NewInputListItem ()
	Creates a new input list item including expressions 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.ConfigurationParameterList	ConfigurationParametersList `[get]`
	Returns the configuration/watch parameters list More...

unsafe string	HeaderFile `[get, set]`
	Returns or sets the header file - matlab speciffic header file, that contains the definition of the interface (inputs, outputs) More...

unsafe NXOpen.Motion.InputPortAssociationList	InputPortsList `[get]`
	Returns the input ports list 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.MechatronicsModelType	MechatronicsType `[get, set]`
	Returns or sets the mechatronics type - possible values are Matlab or Amesim More...

unsafe string	ModelFile `[get, set]`
	Returns or sets the model file - a file path to a MATLAB generated DLL or to an Amesim ame file More...

unsafe string	Name `[get, set]`
	Returns or sets the name of the element More...

unsafe NXOpen.Motion.OutputPortAssociationList	OutputPortsList `[get]`
	Returns the output ports list 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...

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.MechatronicsModelType

the mechatronics type - possible values are Matlab or Amesim

Enumerator
Amesim
Matlab

enum NXOpen.Motion.MechatronicsBuilder.PurposeType

the mechatronics purpose type - possible values are Import and Export

Enumerator
Import
Export

enum NXOpen.Motion.MechatronicsBuilder.SolverCommunicationIntervalType

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

Enumerator
Constant
Variable

enum NXOpen.Motion.MechatronicsBuilder.SolverIntegrationType

the mechatronics integration type - possible values are ModelExchange and CoSimulation

Enumerator
CoSimulation
ModelExchange

Member Function Documentation

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

Searches for the watch parameter by name in the active group

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

inputName

Returns

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

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 )

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

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 )

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

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

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

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 )

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

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

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.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.HeaderFile

getset

Returns or sets the header file - matlab speciffic header file, that contains the definition of the interface (inputs, outputs)

Created in NX11.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

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.MechatronicsModelType NXOpen.Motion.MechatronicsBuilder.MechatronicsType

getset

Returns or sets the mechatronics type - possible values are Matlab or Amesim

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.ModelFile

getset

Returns or sets the model file - a file path to a MATLAB generated DLL or to an Amesim ame file

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 NXOpen.Motion.OutputPortAssociationList NXOpen.Motion.MechatronicsBuilder.OutputPortsList

get

Returns the output ports list

Created in NX11.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:

dotnet_pool/Motion_MechatronicsBuilder.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation