NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Motion::MechatronicsBuilder Class Reference

Represents a Motion::Mechatronics builder
To create a new instance of this class, use NXOpen::Motion::MechatronicsCollection::CreateMechatronicsBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::MechatronicsBuilder:
NXOpen::Motion::MotionBuilder NXOpen::IExternalFileReferencer NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MechatronicsModelType { MechatronicsModelTypeAmesim, MechatronicsModelTypeSimulink }
 The Mechatronics Type. More...
 
enum  PurposeType { PurposeTypeImport, PurposeTypeExport }
 the mechatronics purpose type - possible values are Import and Export More...
 
enum  ReferenceObjectId { ReferenceObjectIdModalFile, ReferenceObjectIdHeaderFile }
 the enum for external file reference object id of mechatronics More...
 
enum  SolverCommunicationIntervalType { SolverCommunicationIntervalTypeConstant, SolverCommunicationIntervalTypeVariable }
 the mechatronics communication interval type - only for Amesim! - possible values are Constant and Variable More...
 
enum  SolverIntegrationType { SolverIntegrationTypeCoSimulation, SolverIntegrationTypeModelExchange }
 the mechatronics integration type - possible values are ModelExchange and CoSimulation More...
 

Public Member Functions

NXString ActiveParameterGroupName ()
 Returns the active configuration parameters group name
Created in NX11.0.0. More...
 
NXString ActivePortVariableGroupName ()
 Returns the active port variable group name
Created in NX11.0.0. More...
 
NXOpen::ExpressionCommunicationInterval ()
 Returns the communication interval
Created in NX11.0.0. More...
 
NXOpen::Motion::MechatronicsBuilder::SolverCommunicationIntervalType CommunicationIntervalType ()
 Returns the communication interval type - possible values are Constant, Variable
Created in NX11.0.0. More...
 
NXOpen::Motion::ConfigurationParameterListConfigurationParametersList ()
 Returns the configuration/watch parameters list
Created in NX11.0.0. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const NXString &externalFileSpec)
 Establish the external reference to the given file specification. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const char *externalFileSpec)
 Establish the external reference to the given file specification. More...
 
NXOpen::Motion::ConfigurationParameterGetConfigurationParameter (const NXString &inputName)
 Searches for the watch parameter by name in the active group
Created in NX11.0.0. More...
 
NXOpen::Motion::ConfigurationParameterGetConfigurationParameter (const char *inputName)
 Searches for the watch parameter by name in the active group
Created in NX11.0.0. More...
 
virtual NXString GetExternalFileDefinitionKey (NXOpen::ExternalFileReferenceAdapter *adapter)
 Gets the file definition to use for external file adapter. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
GetExternalFileReferenceAdapter (int referenceObjectId)
 Returns the external file reference object. More...
 
NXOpen::Motion::InputPortAssociationGetInput (const NXString &inputName)
 Retrieves an input port association from its name
Created in NX11.0.0. More...
 
NXOpen::Motion::InputPortAssociationGetInput (const char *inputName)
 Retrieves an input port association from its name
Created in NX11.0.0. More...
 
NXOpen::Motion::OutputPortAssociationGetOutput (const NXString &inputName)
 Retrieves an output port association from its name
Created in NX11.0.0. More...
 
NXOpen::Motion::OutputPortAssociationGetOutput (const char *inputName)
 Retrieves an output port association from its name
Created in NX11.0.0. More...
 
std::vector< NXStringGetParameterGroupNames ()
 Allows retrieving the list of names of available configuration parameter groups
Created in NX11.0.0. More...
 
NXOpen::Motion::PortVariableGetPortVariable (const NXString &inputName)
 Searches for the watch variable by name in the active group
Created in NX11.0.0. More...
 
NXOpen::Motion::PortVariableGetPortVariable (const char *inputName)
 Searches for the watch variable by name in the active group
Created in NX11.0.0. More...
 
std::vector< NXStringGetPortVariableGroupNames ()
 Allows retrieving the list of names of available port variables groups
Created in NX11.0.0. More...
 
NXString HeaderFile ()
 Returns the header file - matlab speciffic header file, that contains the definition of the interface (inputs, outputs)
More...
 
NXOpen::Motion::InputPortAssociationListInputPortsList ()
 Returns the input ports list
Created in NX11.0.0. More...
 
NXOpen::Motion::MechatronicsBuilder::SolverIntegrationType IntegrationType ()
 Returns the integration type - possible values are CoSimulation, ModelExchange
Created in NX11.0.0. More...
 
NXOpen::Motion::MechatronicsBuilder::MechatronicsModelType MechatronicsType ()
 Returns the mechatronics type - possible values are Matlab or Amesim
Created in NX11.0.0. More...
 
NXString ModelFile ()
 Returns the model file - a file path to a MATLAB generated DLL or to an Amesim ame file
More...
 
NXString Name ()
 Returns the name of the element
Created in NX11.0.0. More...
 
NXOpen::Motion::InputPortAssociationNewInputListItem ()
 Creates a new input list item including expressions. More...
 
NXOpen::Motion::OutputPortAssociationNewOutputListItem ()
 Creates a new output list item including expressions. More...
 
NXOpen::Motion::OutputPortAssociationListOutputPortsList ()
 Returns the output ports list
Created in NX11.0.0. More...
 
NXOpen::Motion::PortVariableListPortVariablesList ()
 Returns the watch variables list
Created in NX11.0.0. More...
 
NXOpen::Motion::MechatronicsBuilder::PurposeType Purpose ()
 Returns the purpose of the mechatronics element - possible values are Import, Export
Created in NX11.0.0. More...
 
void ReadInterfaceFromFile (const NXString &filePath)
 Reads the input/output definition of a mechatronics element from an external file, when purpose is specified as Export. More...
 
void ReadInterfaceFromFile (const char *filePath)
 Reads the input/output definition of a mechatronics element from an external file, when purpose is specified as Export. More...
 
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
Created in NX11.0.0. More...
 
void SetActiveParameterGroupName (const NXString &name)
 Sets the active configuration parameters group name
Created in NX11.0.0. More...
 
void SetActiveParameterGroupName (const char *name)
 Sets the active configuration parameters group name
Created in NX11.0.0. More...
 
void SetActivePortVariableGroupName (const NXString &name)
 Sets the active port variable group name
Created in NX11.0.0. More...
 
void SetActivePortVariableGroupName (const char *name)
 Sets the active port variable group name
Created in NX11.0.0. More...
 
void SetCommunicationInterval (NXOpen::Expression *communicationInterval)
 Sets the communication interval
Created in NX11.0.0. More...
 
void SetCommunicationIntervalType (NXOpen::Motion::MechatronicsBuilder::SolverCommunicationIntervalType communicationIntervalType)
 Sets the communication interval type - possible values are Constant, Variable
Created in NX11.0.0. More...
 
virtual void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter *adapter)
 Sets the external file reference object. More...
 
void SetHeaderFile (const NXString &filename)
 Sets the header file - matlab speciffic header file, that contains the definition of the interface (inputs, outputs)
More...
 
void SetHeaderFile (const char *filename)
 Sets the header file - matlab speciffic header file, that contains the definition of the interface (inputs, outputs)
More...
 
void SetIntegrationType (NXOpen::Motion::MechatronicsBuilder::SolverIntegrationType integrationType)
 Sets the integration type - possible values are CoSimulation, ModelExchange
Created in NX11.0.0. More...
 
void SetMechatronicsType (NXOpen::Motion::MechatronicsBuilder::MechatronicsModelType mechatronicsType)
 Sets the mechatronics type - possible values are Matlab or Amesim
Created in NX11.0.0. More...
 
void SetModelFile (const NXString &filename)
 Sets the model file - a file path to a MATLAB generated DLL or to an Amesim ame file
More...
 
void SetModelFile (const char *filename)
 Sets the model file - a file path to a MATLAB generated DLL or to an Amesim ame file
More...
 
void SetName (const NXString &name)
 Sets the name of the element
Created in NX11.0.0. More...
 
void SetName (const char *name)
 Sets the name of the element
Created in NX11.0.0. More...
 
void SetPurpose (NXOpen::Motion::MechatronicsBuilder::PurposeType purpose)
 Sets the purpose of the mechatronics element - possible values are Import, Export
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Motion::MotionBuilder
double DisplayScale ()
 Returns the icon display scale
Created in NX5.0.0. More...
 
NXString GroupName ()
 Returns the group name
Created in NX5.0.0. More...
 
NXOpen::Motion::MotionObject::GroupType GroupType ()
 Returns the group type
Created in NX5.0.0. More...
 
void SetDisplayScale (double displayScale)
 Sets the icon display scale
Created in NX5.0.0. More...
 
void SetGroupName (const NXString &groupName)
 Sets the group name
Created in NX5.0.0. More...
 
void SetGroupName (const char *groupName)
 Sets the group name
Created in NX5.0.0. More...
 
void SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType)
 Sets the group type
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. 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

The Mechatronics Type.

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

Enumerator
MechatronicsModelTypeAmesim 

amesim

MechatronicsModelTypeSimulink 

simulink

the mechatronics purpose type - possible values are Import and Export

Enumerator
PurposeTypeImport 

import

PurposeTypeExport 

export

the enum for external file reference object id of mechatronics

Enumerator
ReferenceObjectIdModalFile 

modal file

ReferenceObjectIdHeaderFile 

header file

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

Enumerator
SolverCommunicationIntervalTypeConstant 

constant

SolverCommunicationIntervalTypeVariable 

variable

the mechatronics integration type - possible values are ModelExchange and CoSimulation

Enumerator
SolverIntegrationTypeCoSimulation 

co simulation

SolverIntegrationTypeModelExchange 

model exchange

Member Function Documentation

NXString NXOpen::Motion::MechatronicsBuilder::ActiveParameterGroupName ( )

Returns the active configuration parameters group name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::MechatronicsBuilder::ActivePortVariableGroupName ( )

Returns the active port variable group name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::MechatronicsBuilder::CommunicationInterval ( )

Returns the communication interval
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MechatronicsBuilder::SolverCommunicationIntervalType NXOpen::Motion::MechatronicsBuilder::CommunicationIntervalType ( )

Returns the communication interval type - possible values are Constant, Variable
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ConfigurationParameterList* NXOpen::Motion::MechatronicsBuilder::ConfigurationParametersList ( )

Returns the configuration/watch parameters list
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::MechatronicsBuilder::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const NXString externalFileSpec 
)
virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::MechatronicsBuilder::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const char *  externalFileSpec 
)
virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implements NXOpen::IExternalFileReferencer.

NXOpen::Motion::ConfigurationParameter* NXOpen::Motion::MechatronicsBuilder::GetConfigurationParameter ( const NXString inputName)

Searches for the watch parameter by name in the active group
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
NXOpen::Motion::ConfigurationParameter* NXOpen::Motion::MechatronicsBuilder::GetConfigurationParameter ( const char *  inputName)

Searches for the watch parameter by name in the active group
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
virtual NXString NXOpen::Motion::MechatronicsBuilder::GetExternalFileDefinitionKey ( NXOpen::ExternalFileReferenceAdapter adapter)
virtual

Gets the file definition to use for external file adapter.


Created in NX1847.0.0.

License requirements : None

Parameters
adapterexternal file reference object

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::MechatronicsBuilder::GetExternalFileReferenceAdapter ( int  referenceObjectId)
virtual

Returns the external file reference object.

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

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references

Implements NXOpen::IExternalFileReferencer.

NXOpen::Motion::InputPortAssociation* NXOpen::Motion::MechatronicsBuilder::GetInput ( const NXString inputName)

Retrieves an input port association from its name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
NXOpen::Motion::InputPortAssociation* NXOpen::Motion::MechatronicsBuilder::GetInput ( const char *  inputName)

Retrieves an input port association from its name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
NXOpen::Motion::OutputPortAssociation* NXOpen::Motion::MechatronicsBuilder::GetOutput ( const NXString inputName)

Retrieves an output port association from its name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
NXOpen::Motion::OutputPortAssociation* NXOpen::Motion::MechatronicsBuilder::GetOutput ( const char *  inputName)

Retrieves an output port association from its name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
std::vector<NXString> NXOpen::Motion::MechatronicsBuilder::GetParameterGroupNames ( )

Allows retrieving the list of names of available configuration parameter groups
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::PortVariable* NXOpen::Motion::MechatronicsBuilder::GetPortVariable ( const NXString inputName)

Searches for the watch variable by name in the active group
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
NXOpen::Motion::PortVariable* NXOpen::Motion::MechatronicsBuilder::GetPortVariable ( const char *  inputName)

Searches for the watch variable by name in the active group
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
inputNameinputname
std::vector<NXString> NXOpen::Motion::MechatronicsBuilder::GetPortVariableGroupNames ( )

Allows retrieving the list of names of available port variables groups
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::MechatronicsBuilder::HeaderFile ( )

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

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::InputPortAssociationList* NXOpen::Motion::MechatronicsBuilder::InputPortsList ( )

Returns the input ports list
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MechatronicsBuilder::SolverIntegrationType NXOpen::Motion::MechatronicsBuilder::IntegrationType ( )

Returns the integration type - possible values are CoSimulation, ModelExchange
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MechatronicsBuilder::MechatronicsModelType NXOpen::Motion::MechatronicsBuilder::MechatronicsType ( )

Returns the mechatronics type - possible values are Matlab or Amesim
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::MechatronicsBuilder::ModelFile ( )

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

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::MechatronicsBuilder::Name ( )

Returns the name of the element
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::InputPortAssociation* NXOpen::Motion::MechatronicsBuilder::NewInputListItem ( )

Creates a new input list item including expressions.

Returns

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::OutputPortAssociation* NXOpen::Motion::MechatronicsBuilder::NewOutputListItem ( )

Creates a new output list item including expressions.

Returns

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::OutputPortAssociationList* NXOpen::Motion::MechatronicsBuilder::OutputPortsList ( )

Returns the output ports list
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::PortVariableList* NXOpen::Motion::MechatronicsBuilder::PortVariablesList ( )

Returns the watch variables list
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MechatronicsBuilder::PurposeType NXOpen::Motion::MechatronicsBuilder::Purpose ( )

Returns the purpose of the mechatronics element - possible values are Import, Export
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::MechatronicsBuilder::ReadInterfaceFromFile ( const NXString 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
filePathfilepath
void NXOpen::Motion::MechatronicsBuilder::ReadInterfaceFromFile ( const char *  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
filePathfilepath
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")

void NXOpen::Motion::MechatronicsBuilder::SetActiveParameterGroupName ( const NXString name)

Sets the active configuration parameters group name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MechatronicsBuilder::SetActiveParameterGroupName ( const char *  name)

Sets the active configuration parameters group name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MechatronicsBuilder::SetActivePortVariableGroupName ( const NXString name)

Sets the active port variable group name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MechatronicsBuilder::SetActivePortVariableGroupName ( const char *  name)

Sets the active port variable group name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MechatronicsBuilder::SetCommunicationInterval ( NXOpen::Expression communicationInterval)

Sets the communication interval
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
communicationIntervalcommunicationinterval
void NXOpen::Motion::MechatronicsBuilder::SetCommunicationIntervalType ( NXOpen::Motion::MechatronicsBuilder::SolverCommunicationIntervalType  communicationIntervalType)

Sets the communication interval type - possible values are Constant, Variable
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
communicationIntervalTypecommunicationintervaltype
virtual void NXOpen::Motion::MechatronicsBuilder::SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter adapter 
)
virtual

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
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
adapterexternal file reference object

Implements NXOpen::IExternalFileReferencer.

void NXOpen::Motion::MechatronicsBuilder::SetHeaderFile ( const NXString filename)

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

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
filenamefilename
void NXOpen::Motion::MechatronicsBuilder::SetHeaderFile ( const char *  filename)

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

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
filenamefilename
void NXOpen::Motion::MechatronicsBuilder::SetIntegrationType ( NXOpen::Motion::MechatronicsBuilder::SolverIntegrationType  integrationType)

Sets the integration type - possible values are CoSimulation, ModelExchange
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
integrationTypeintegrationtype
void NXOpen::Motion::MechatronicsBuilder::SetMechatronicsType ( NXOpen::Motion::MechatronicsBuilder::MechatronicsModelType  mechatronicsType)

Sets the mechatronics type - possible values are Matlab or Amesim
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
mechatronicsTypemechatronicstype
void NXOpen::Motion::MechatronicsBuilder::SetModelFile ( const NXString filename)

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

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
filenamefilename
void NXOpen::Motion::MechatronicsBuilder::SetModelFile ( const char *  filename)

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

Deprecated:
Deprecated in NX1847.0.0.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
filenamefilename
void NXOpen::Motion::MechatronicsBuilder::SetName ( const NXString name)

Sets the name of the element
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MechatronicsBuilder::SetName ( const char *  name)

Sets the name of the element
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MechatronicsBuilder::SetPurpose ( NXOpen::Motion::MechatronicsBuilder::PurposeType  purpose)

Sets the purpose of the mechatronics element - possible values are Import, Export
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
purposepurpose

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