public interface MechatronicsBuilder extends MotionBuilder
Mechatronics
builder MechatronicsCollection.createMechatronicsBuilder(nxopen.motion.Mechatronics)
Property | Value |
---|---|
CommunicationInterval.Value | 0.01 (millimeters part), 0.01 (inches part) |
CommunicationIntervalType | Constant |
IntegrationType | CoSimulation |
MechatronicsType | Amesim |
Purpose | Import |
Modifier and Type | Interface and Description |
---|---|
static class |
MechatronicsBuilder.MechatronicsModelType
the mechatronics type - possible values are Matlab or Amesim
|
static class |
MechatronicsBuilder.PurposeType
the mechatronics purpose type - possible values are Import and Export
|
static class |
MechatronicsBuilder.SolverCommunicationIntervalType
the mechatronics communication interval type - only for Amesim!
|
static class |
MechatronicsBuilder.SolverIntegrationType
the mechatronics integration type - possible values are ModelExchange and CoSimulation
|
Modifier and Type | Method and Description |
---|---|
String |
activeParameterGroupName()
Returns the active configuration parameters group name
License requirements: mechanisms ("MECHANISMS") . |
String |
activePortVariableGroupName()
Returns the active port variable group name
License requirements: mechanisms ("MECHANISMS") . |
Expression |
communicationInterval()
Returns the communication interval
License requirements: mechanisms ("MECHANISMS") . |
MechatronicsBuilder.SolverCommunicationIntervalType |
communicationIntervalType()
Returns the communication interval type - possible values are Constant, Variable
License requirements: mechanisms ("MECHANISMS") . |
ConfigurationParameterList |
configurationParametersList()
Returns the configuration/watch parameters list
License requirements: mechanisms ("MECHANISMS") . |
ConfigurationParameter |
getConfigurationParameter(String inputName)
Searches for the watch parameter by name in the active group
License requirements: mechanisms ("MECHANISMS") . |
InputPortAssociation |
getInput(String inputName)
Retrieves an input port association from its name
License requirements: mechanisms ("MECHANISMS") . |
OutputPortAssociation |
getOutput(String inputName)
Retrieves an output port association from its name
License requirements: mechanisms ("MECHANISMS") . |
String[] |
getParameterGroupNames()
Allows retrieving the list of names of available configuration parameter groups
License requirements: mechanisms ("MECHANISMS") . |
PortVariable |
getPortVariable(String inputName)
Searches for the watch variable by name in the active group
License requirements: mechanisms ("MECHANISMS") . |
String[] |
getPortVariableGroupNames()
Allows retrieving the list of names of available port variables groups
License requirements: mechanisms ("MECHANISMS") . |
String |
headerFile()
Returns the header file - matlab speciffic header file, that contains the definition of the interface (inputs, outputs)
License requirements: mechanisms ("MECHANISMS") . |
InputPortAssociationList |
inputPortsList()
Returns the input ports list
License requirements: mechanisms ("MECHANISMS") . |
MechatronicsBuilder.SolverIntegrationType |
integrationType()
Returns the integration type - possible values are CoSimulation, ModelExchange
License requirements: mechanisms ("MECHANISMS") . |
MechatronicsBuilder.MechatronicsModelType |
mechatronicsType()
Returns the mechatronics type - possible values are Matlab or Amesim
License requirements: mechanisms ("MECHANISMS") . |
String |
modelFile()
Returns the model file - a file path to a MATLAB generated DLL or to an Amesim ame file
License requirements: mechanisms ("MECHANISMS") . |
String |
name()
Returns the name of the element
License requirements: mechanisms ("MECHANISMS") . |
InputPortAssociation |
newInputListItem()
Creates a new input list item including expressions
License requirements: mechanisms ("MECHANISMS") . |
OutputPortAssociation |
newOutputListItem()
Creates a new output list item including expressions
License requirements: mechanisms ("MECHANISMS") . |
OutputPortAssociationList |
outputPortsList()
Returns the output ports list
License requirements: mechanisms ("MECHANISMS") . |
PortVariableList |
portVariablesList()
Returns the watch variables list
License requirements: mechanisms ("MECHANISMS") . |
MechatronicsBuilder.PurposeType |
purpose()
Returns the purpose of the mechatronics element - possible values are Import, Export
License requirements: mechanisms ("MECHANISMS") . |
void |
readInterfaceFromFile(String filePath)
Reads the input/output definition of a mechatronics element from an external file, when purpose
is specified as Export.
|
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
License requirements: mechanisms ("MECHANISMS") . |
void |
setActiveParameterGroupName(String name)
License requirements: mechanisms ("MECHANISMS") . |
void |
setActivePortVariableGroupName(String name)
License requirements: mechanisms ("MECHANISMS") . |
void |
setCommunicationInterval(Expression communicationInterval)
License requirements: mechanisms ("MECHANISMS") . |
void |
setCommunicationIntervalType(MechatronicsBuilder.SolverCommunicationIntervalType communicationIntervalType)
License requirements: mechanisms ("MECHANISMS") . |
void |
setHeaderFile(String filename)
License requirements: mechanisms ("MECHANISMS") . |
void |
setIntegrationType(MechatronicsBuilder.SolverIntegrationType integrationType)
License requirements: mechanisms ("MECHANISMS") . |
void |
setMechatronicsType(MechatronicsBuilder.MechatronicsModelType mechatronicsType)
License requirements: mechanisms ("MECHANISMS") . |
void |
setModelFile(String filename)
License requirements: mechanisms ("MECHANISMS") . |
void |
setName(String name)
License requirements: mechanisms ("MECHANISMS") . |
void |
setPurpose(MechatronicsBuilder.PurposeType purpose)
License requirements: mechanisms ("MECHANISMS") . |
displayScale, groupName, groupType, setDisplayScale, setGroupName, setGroupType
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
MechatronicsBuilder.MechatronicsModelType mechatronicsType() throws NXException, RemoteException
NXException
RemoteException
void setMechatronicsType(MechatronicsBuilder.MechatronicsModelType mechatronicsType) throws NXException, RemoteException
mechatronicsType
- NXException
RemoteException
MechatronicsBuilder.PurposeType purpose() throws NXException, RemoteException
NXException
RemoteException
void setPurpose(MechatronicsBuilder.PurposeType purpose) throws NXException, RemoteException
purpose
- NXException
RemoteException
MechatronicsBuilder.SolverIntegrationType integrationType() throws NXException, RemoteException
NXException
RemoteException
void setIntegrationType(MechatronicsBuilder.SolverIntegrationType integrationType) throws NXException, RemoteException
integrationType
- NXException
RemoteException
MechatronicsBuilder.SolverCommunicationIntervalType communicationIntervalType() throws NXException, RemoteException
NXException
RemoteException
void setCommunicationIntervalType(MechatronicsBuilder.SolverCommunicationIntervalType communicationIntervalType) throws NXException, RemoteException
communicationIntervalType
- NXException
RemoteException
Expression communicationInterval() throws NXException, RemoteException
NXException
RemoteException
void setCommunicationInterval(Expression communicationInterval) throws NXException, RemoteException
communicationInterval
- NXException
RemoteException
String modelFile() throws NXException, RemoteException
NXException
RemoteException
void setModelFile(String filename) throws NXException, RemoteException
filename
- NXException
RemoteException
String headerFile() throws NXException, RemoteException
NXException
RemoteException
void setHeaderFile(String filename) throws NXException, RemoteException
filename
- NXException
RemoteException
String name() throws NXException, RemoteException
NXException
RemoteException
void setName(String name) throws NXException, RemoteException
name
- NXException
RemoteException
String activeParameterGroupName() throws NXException, RemoteException
NXException
RemoteException
void setActiveParameterGroupName(String name) throws NXException, RemoteException
name
- NXException
RemoteException
String activePortVariableGroupName() throws NXException, RemoteException
NXException
RemoteException
void setActivePortVariableGroupName(String name) throws NXException, RemoteException
name
- NXException
RemoteException
void readInterfaceFromFile(String filePath) throws NXException, RemoteException
filePath
- NXException
RemoteException
void refreshLists() throws NXException, RemoteException
NXException
RemoteException
String[] getParameterGroupNames() throws NXException, RemoteException
NXException
RemoteException
String[] getPortVariableGroupNames() throws NXException, RemoteException
NXException
RemoteException
InputPortAssociation getInput(String inputName) throws NXException, RemoteException
inputName
- NXException
RemoteException
OutputPortAssociation getOutput(String inputName) throws NXException, RemoteException
inputName
- NXException
RemoteException
PortVariable getPortVariable(String inputName) throws NXException, RemoteException
inputName
- NXException
RemoteException
ConfigurationParameter getConfigurationParameter(String inputName) throws NXException, RemoteException
inputName
- NXException
RemoteException
InputPortAssociationList inputPortsList() throws NXException, RemoteException
NXException
RemoteException
OutputPortAssociationList outputPortsList() throws NXException, RemoteException
NXException
RemoteException
OutputPortAssociation newOutputListItem() throws NXException, RemoteException
NXException
RemoteException
InputPortAssociation newInputListItem() throws NXException, RemoteException
NXException
RemoteException
ConfigurationParameterList configurationParametersList() throws NXException, RemoteException
NXException
RemoteException
PortVariableList portVariablesList() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.