MATLABSignalConnectionBuilder Class

class NXOpen.Mechatronics.MATLABSignalConnectionBuilder

Bases: NXOpen.Builder

Represents a Mechatronics.MATLABSignalConnectionBuilder

To create a new instance of this class, use NXOpen.Mechatronics.MATLABSignalConnectionCollection.CreateSignalConnectionBuilder()

New in version NX11.0.0.

Properties

Property Description
AdapterIdentify Returns or sets the adapter object.
MATLABSignalName Returns or sets the MATLAB signal name.
MATLABSignalPort Returns or sets the MATLAB signal port type.
MATLABSignalType Returns or sets the MATLAB signal type.
ModelName Returns or sets the matlab model name.
ResultName Returns or sets the mapping result name.
SignalIdentify Returns or sets the signal object.
StreamIO Returns or sets the mapping direction.
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

MATLABSignalConnectionBuilderDataType Enumeration Represents the OPC signal data type.

Property Detail

AdapterIdentify

MATLABSignalConnectionBuilder.AdapterIdentify

Returns or sets the adapter object.

-------------------------------------

Getter Method

Signature AdapterIdentify

Returns:
Return type:NXOpen.Mechatronics.SignalAdapter

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature AdapterIdentify

Parameters:adapterIdentify (NXOpen.Mechatronics.SignalAdapter) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MATLABSignalName

MATLABSignalConnectionBuilder.MATLABSignalName

Returns or sets the MATLAB signal name.

-------------------------------------

Getter Method

Signature MATLABSignalName

Returns:
Return type:str

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MATLABSignalName

Parameters:matlabsignalName (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MATLABSignalPort

MATLABSignalConnectionBuilder.MATLABSignalPort

Returns or sets the MATLAB signal port type.

-------------------------------------

Getter Method

Signature MATLABSignalPort

Returns:
Return type:NXOpen.Mechatronics.MATLABClientBuilderDataPortType

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MATLABSignalPort

Parameters:matlabSignalPort (NXOpen.Mechatronics.MATLABClientBuilderDataPortType) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MATLABSignalType

MATLABSignalConnectionBuilder.MATLABSignalType

Returns or sets the MATLAB signal type.

-------------------------------------

Getter Method

Signature MATLABSignalType

Returns:
Return type:NXOpen.Mechatronics.MATLABSignalConnectionBuilderDataType

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MATLABSignalType

Parameters:matlabSignalType (NXOpen.Mechatronics.MATLABSignalConnectionBuilderDataType) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ModelName

MATLABSignalConnectionBuilder.ModelName

Returns or sets the matlab model name.

-------------------------------------

Getter Method

Signature ModelName

Returns:
Return type:str

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ModelName

Parameters:modelName (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ResultName

MATLABSignalConnectionBuilder.ResultName

Returns or sets the mapping result name.

-------------------------------------

Getter Method

Signature ResultName

Returns:
Return type:str

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ResultName

Parameters:resultName (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SignalIdentify

MATLABSignalConnectionBuilder.SignalIdentify

Returns or sets the signal object.

-------------------------------------

Getter Method

Signature SignalIdentify

Returns:
Return type:NXOpen.NXObject

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature SignalIdentify

Parameters:signalIdentify (NXOpen.NXObject) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StreamIO

MATLABSignalConnectionBuilder.StreamIO

Returns or sets the mapping direction.

0 represent input, 1 represent output

-------------------------------------

Getter Method

Signature StreamIO

Returns:
Return type:int

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature StreamIO

Parameters:streamIO (int) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

MATLABSignalConnectionBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.