NXOpen .NET Reference Guide
|
Represents a Motion.Mechatronics builder More...
Public Types | |
enum | MechatronicsModelType { Amesim, Simulink } |
The Mechatronics Type More... | |
enum | PurposeType { Import, Export } |
the mechatronics purpose type - possible values are Import and Export More... | |
enum | ReferenceObjectId { ModalFile, HeaderFile } |
the enum for external file reference object id of mechatronics More... | |
enum | SolverCommunicationIntervalType { Constant, Variable } |
the mechatronics communication interval type - only for Amesim! - possible values are Constant and Variable 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.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... | |
Additional Inherited Members | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> More... | |
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
|
inline |
Establish the external reference to the given file specification.
Created in NX1847.0.0
License requirements: None.
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. |
Implements NXOpen.IExternalFileReferencer.
|
inline |
Searches for the watch parameter by name in the active group
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
inputName |
|
inline |
Gets the file definition to use for external file adapter.
Created in NX1847.0.0
License requirements: None.
adapter | external file reference object |
Implements NXOpen.IExternalFileReferencer.
|
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.
referenceObjectId | the unique identifier of the external reference required in case where referencer has multiple external references |
Implements NXOpen.IExternalFileReferencer.
|
inline |
Retrieves an input port association from its name
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
inputName |
|
inline |
Retrieves an output port association from its name
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
inputName |
|
inline |
Allows retrieving the list of names of available configuration parameter groups
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
inline |
Searches for the watch variable by name in the active group
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
inputName |
|
inline |
Allows retrieving the list of names of available port variables groups
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
inline |
Creates a new input list item including expressions
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
inline |
Creates a new output list item including expressions
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
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")
filePath |
|
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")
|
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.
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.
|
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")
|
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")
|
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")
|
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")
|
get |
Returns the configuration/watch parameters list
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
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
Deprecated in NX1847.0.0. Use NXOpen.IExternalFileReferencer.GetExternalFileReferenceAdapter
License requirements to get this property: mechanisms ("MECHANISMS")
License requirements to set this property: mechanisms ("MECHANISMS")
|
get |
Returns the input ports list
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
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")
|
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")
|
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
Deprecated in NX1847.0.0. Use NXOpen.IExternalFileReferencer.GetExternalFileReferenceAdapter
License requirements to get this property: mechanisms ("MECHANISMS")
License requirements to set this property: mechanisms ("MECHANISMS")
|
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")
|
get |
Returns the output ports list
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
get |
Returns the watch variables list
Created in NX11.0.0
License requirements: mechanisms ("MECHANISMS")
|
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")