NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.Mechatronics.MATLABClientBuilder Class Reference

Represents a NXOpen.Mechatronics.MATLABClientBuilder More...

Inheritance diagram for NXOpen.Mechatronics.MATLABClientBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _SignalData
 Defines the signal data.
 
struct  _TagAttribute
 the attribute of MATLAB item.
 
struct  _TagInfo
 Represents MATLABTag info definition structure.
 
struct  _TagInfoEx
 Represents Extended MATLAB nodes definition structure.
 
struct  SignalData
 Defines the signal data. More...
 
struct  TagAttribute
 the attribute of MATLAB item. More...
 
struct  TagInfo
 Represents MATLABTag info definition structure. More...
 
struct  TagInfoEx
 Represents Extended MATLAB nodes definition structure. More...
 

Public Types

enum  DataPortType { Input, Output }
 Represents the data port type. More...
 
enum  DataType { Bool, Int, Double }
 Represents the data type. More...
 

Public Member Functions

unsafe void GetAvailableItems (out string[] signalName, out NXOpen.Mechatronics.MATLABClientBuilder.DataType[] signalType)
 Get the available MATLAB items. More...
 
unsafe void GetItemAttributes (out NXOpen.Mechatronics.MATLABClientBuilder.TagAttribute[] attr)
 Get the attribute of MATLAB items More...
 
unsafe void GetMATLABInformation (string instanceName, out NXOpen.Mechatronics.MATLABClientBuilder.TagInfo[] tagInfos)
 Get the object information into MATLAB Data More...
 
unsafe void GetMATLABInformationEx (string instanceName, out NXOpen.Mechatronics.MATLABClientBuilder.TagInfoEx[] tagInfos)
 Get the object information into MATLAB DataEx More...
 
unsafe
NXOpen.Mechatronics.MATLABClientBuilder.TagInfo[] 
GetServerTags (string serverName)
 Gets MATLAB instance Tags More...
 
unsafe void SetAvailableItems (string[] signalName, NXOpen.Mechatronics.MATLABClientBuilder.DataType[] signalType)
 Set the available MATLAB items. More...
 
unsafe void SetItemAttributes (NXOpen.Mechatronics.MATLABClientBuilder.TagAttribute[] attr)
 Set the attribute of MATLAB items More...
 
unsafe void SetMATLABInformation (string instanceName, NXOpen.Mechatronics.MATLABClientBuilder.TagInfo[] tagInfos)
 Set the object information into MATLAB Data More...
 
unsafe void SetMATLABInformationEx (string instanceName, NXOpen.Mechatronics.MATLABClientBuilder.TagInfoEx[] tagInfos)
 Set the object information into MATLAB DataEx More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string MatlabFileBrowser [get, set]
 Returns or sets the simulink file browser. More...
 
unsafe string MATLABServerProgID [get, set]
 Returns or sets the MATLAB server prog ID. More...
 
unsafe string SelectedConfigurationName [get, set]
 Returns or sets the selected configuration name. More...
 
unsafe NXOpen.Part SelectedConfigurationPart [get, set]
 Returns or sets the selected configuration part. More...
 
unsafe NXOpen.Expression UpdateTime [get]
 Returns the update time. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Mechatronics.MATLABClientBuilder

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

Created in NX11.0.0

Member Enumeration Documentation

Represents the data port type.

Enumerator
Input 

Input

Output 

Output

Represents the data type.

Enumerator
Bool 

bool

Int 

int

Double 

double

Member Function Documentation

unsafe void NXOpen.Mechatronics.MATLABClientBuilder.GetAvailableItems ( out string[]  signalName,
out NXOpen.Mechatronics.MATLABClientBuilder.DataType[]  signalType 
)
inline

Get the available MATLAB items.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
signalName
signalType
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.GetItemAttributes ( out NXOpen.Mechatronics.MATLABClientBuilder.TagAttribute[]  attr)
inline

Get the attribute of MATLAB items

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
attr
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.GetMATLABInformation ( string  instanceName,
out NXOpen.Mechatronics.MATLABClientBuilder.TagInfo[]  tagInfos 
)
inline

Get the object information into MATLAB Data

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceName
tagInfosArray of TagInfos
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.GetMATLABInformationEx ( string  instanceName,
out NXOpen.Mechatronics.MATLABClientBuilder.TagInfoEx[]  tagInfos 
)
inline

Get the object information into MATLAB DataEx

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceName
tagInfosArray of TagInfos
unsafe NXOpen.Mechatronics.MATLABClientBuilder.TagInfo [] NXOpen.Mechatronics.MATLABClientBuilder.GetServerTags ( string  serverName)
inline

Gets MATLAB instance Tags

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
serverName
Returns
Array of TagInfos
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.SetAvailableItems ( string[]  signalName,
NXOpen.Mechatronics.MATLABClientBuilder.DataType[]  signalType 
)
inline

Set the available MATLAB items.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
signalName
signalType
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.SetItemAttributes ( NXOpen.Mechatronics.MATLABClientBuilder.TagAttribute[]  attr)
inline

Set the attribute of MATLAB items

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
attr
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.SetMATLABInformation ( string  instanceName,
NXOpen.Mechatronics.MATLABClientBuilder.TagInfo[]  tagInfos 
)
inline

Set the object information into MATLAB Data

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceName
tagInfosArray of TagInfos
unsafe void NXOpen.Mechatronics.MATLABClientBuilder.SetMATLABInformationEx ( string  instanceName,
NXOpen.Mechatronics.MATLABClientBuilder.TagInfoEx[]  tagInfos 
)
inline

Set the object information into MATLAB DataEx

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
instanceName
tagInfosArray of TagInfos

Property Documentation

unsafe string NXOpen.Mechatronics.MATLABClientBuilder.MatlabFileBrowser
getset

Returns or sets the simulink file browser.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe string NXOpen.Mechatronics.MATLABClientBuilder.MATLABServerProgID
getset

Returns or sets the MATLAB server prog ID.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe string NXOpen.Mechatronics.MATLABClientBuilder.SelectedConfigurationName
getset

Returns or sets the selected configuration name.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Part NXOpen.Mechatronics.MATLABClientBuilder.SelectedConfigurationPart
getset

Returns or sets the selected configuration part.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Expression NXOpen.Mechatronics.MATLABClientBuilder.UpdateTime
get

Returns the update time.

Created in NX11.0.0

License requirements: None.


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