MATLABClientBuilder Class

class NXOpen.Mechatronics.MATLABClientBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.MATLABClientBuilder

This class is sub-object of another builder, and cannot be directly instantiated.

New in version NX11.0.0.

Properties

Property Description
MATLABServerProgID Returns or sets the MATLAB server prog ID.
MatlabFileBrowser Returns or sets the simulink file browser.
SelectedConfigurationName Returns or sets the selected configuration name.
SelectedConfigurationPart Returns or sets the selected configuration part.
Tag Returns the Tag for this object.
UpdateTime Returns the update time.

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.
GetAvailableItems Get the available MATLAB items.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetItemAttributes Get the attribute of MATLAB items
GetMATLABInformation Get the object information into MATLAB Data
GetObject Returns the object currently being edited by this builder.
GetServerTags Gets MATLAB instance Tags
SetAvailableItems Set the available MATLAB items.
SetItemAttributes Set the attribute of MATLAB items
SetMATLABInformation Set the object information into MATLAB Data
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

MATLABClientBuilderDataPortType Enumeration Represents the data port type.
MATLABClientBuilderDataType Enumeration Represents the data type.

Structs

MATLABClientBuilderSignalData_Struct Struct Defines the signal data.
MATLABClientBuilderTagAttribute_Struct Struct the attribute of MATLAB item.
MATLABClientBuilderTagInfo_Struct Struct
Represents MATLABTag info definition structure.

Property Detail

MATLABServerProgID

MATLABClientBuilder.MATLABServerProgID

Returns or sets the MATLAB server prog ID.

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

Getter Method

Signature MATLABServerProgID

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature MATLABServerProgID

Parameters:matlabServerProgID (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MatlabFileBrowser

MATLABClientBuilder.MatlabFileBrowser

Returns or sets the simulink file browser.

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

Getter Method

Signature MatlabFileBrowser

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature MatlabFileBrowser

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectedConfigurationName

MATLABClientBuilder.SelectedConfigurationName

Returns or sets the selected configuration name.

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

Getter Method

Signature SelectedConfigurationName

Returns:
Return type:str

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature SelectedConfigurationName

Parameters:configurationName (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectedConfigurationPart

MATLABClientBuilder.SelectedConfigurationPart

Returns or sets the selected configuration part.

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

Getter Method

Signature SelectedConfigurationPart

Returns:
Return type:NXOpen.Part

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature SelectedConfigurationPart

Parameters:ownerPart (NXOpen.Part) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

UpdateTime

MATLABClientBuilder.UpdateTime

Returns the update time.

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

Getter Method

Signature UpdateTime

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

Method Detail

GetAvailableItems

MATLABClientBuilder.GetAvailableItems

Get the available MATLAB items.

Signature GetAvailableItems()

Returns:a tuple
Return type:A tuple consisting of (signalName, signalType). signalName is a list of str. signalType is a list of NXOpen.Mechatronics.MATLABClientBuilderDataType.

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetItemAttributes

MATLABClientBuilder.GetItemAttributes

Get the attribute of MATLAB items

Signature GetItemAttributes()

Returns:
Return type:list of NXOpen.Mechatronics.MATLABClientBuilderTagAttribute_Struct

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetMATLABInformation

MATLABClientBuilder.GetMATLABInformation

Get the object information into MATLAB Data

Signature GetMATLABInformation(instanceName)

Parameters:instanceName (str) –
Returns:Array of TagInfos
Return type:list of NXOpen.Mechatronics.MATLABClientBuilderTagInfo_Struct

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetServerTags

MATLABClientBuilder.GetServerTags

Gets MATLAB instance Tags

Signature GetServerTags(serverName)

Parameters:serverName (str) –
Returns:Array of TagInfos
Return type:list of NXOpen.Mechatronics.MATLABClientBuilderTagInfo_Struct

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetAvailableItems

MATLABClientBuilder.SetAvailableItems

Set the available MATLAB items.

Signature SetAvailableItems(signalName, signalType)

Parameters:

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetItemAttributes

MATLABClientBuilder.SetItemAttributes

Set the attribute of MATLAB items

Signature SetItemAttributes(attr)

Parameters:attr (list of NXOpen.Mechatronics.MATLABClientBuilderTagAttribute_Struct) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetMATLABInformation

MATLABClientBuilder.SetMATLABInformation

Set the object information into MATLAB Data

Signature SetMATLABInformation(instanceName, tagInfos)

Parameters:

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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