Represents a NXOpen::Mechatronics::MATLABClientBuilder
This class is sub-object of another builder, and cannot be directly instantiated. More...

Inheritance diagram for NXOpen::Mechatronics::MATLABClientBuilder:

Classes
struct	SignalData
	Defines the signal data. More...

struct	TagAttribute
	the attribute of MATLAB item. More...

struct	TagInfo
	Represents MATLABTag info definition structure. More...

Public Types
enum	DataPortType { DataPortTypeInput, DataPortTypeOutput }
	Represents the data port type. More...

enum	DataType { DataTypeBool, DataTypeInt, DataTypeDouble }
	Represents the data type. More...

Public Member Functions
void	GetAvailableItems (std::vector< NXString > &signalName, std::vector< NXOpen::Mechatronics::MATLABClientBuilder::DataType > &signalType)
	Get the available MATLAB items. More...

void	GetItemAttributes (std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagAttribute > &attr)
	Get the attribute of MATLAB items Created in NX11.0.0. More...

void	GetMATLABInformation (const NXString &instanceName, std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &tagInfos)
	Get the object information into MATLAB Data Created in NX12.0.0. More...

void	GetMATLABInformation (const char *instanceName, std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &tagInfos)
	Get the object information into MATLAB Data Created in NX12.0.0. More...

std::vector < NXOpen::Mechatronics::MATLABClientBuilder::TagInfo >	GetServerTags (const NXString &serverName)
	Gets MATLAB instance Tags. More...

std::vector < NXOpen::Mechatronics::MATLABClientBuilder::TagInfo >	GetServerTags (const char *serverName)
	Gets MATLAB instance Tags. More...

NXString	MatlabFileBrowser ()
	Returns the simulink file browser. More...

NXString	MATLABServerProgID ()
	Returns the MATLAB server prog ID. More...

NXString	SelectedConfigurationName ()
	Returns the selected configuration name. More...

NXOpen::Part *	SelectedConfigurationPart ()
	Returns the selected configuration part. More...

void	SetAvailableItems (const std::vector< NXString > &signalName, const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::DataType > &signalType)
	Set the available MATLAB items. More...

void	SetItemAttributes (const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagAttribute > &attr)
	Set the attribute of MATLAB items Created in NX11.0.0. More...

void	SetMatlabFileBrowser (const NXString &filename)
	Sets the simulink file browser. More...

void	SetMatlabFileBrowser (const char *filename)
	Sets the simulink file browser. More...

void	SetMATLABInformation (const NXString &instanceName, const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &tagInfos)
	Set the object information into MATLAB Data. More...

void	SetMATLABInformation (const char *instanceName, const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &tagInfos)
	Set the object information into MATLAB Data. More...

void	SetMATLABServerProgID (const NXString &matlabServerProgID)
	Sets the MATLAB server prog ID. More...

void	SetMATLABServerProgID (const char *matlabServerProgID)
	Sets the MATLAB server prog ID. More...

void	SetSelectedConfigurationName (const NXString &configurationName)
	Sets the selected configuration name. More...

void	SetSelectedConfigurationName (const char *configurationName)
	Sets the selected configuration name. More...

void	SetSelectedConfigurationPart (NXOpen::Part *ownerPart)
	Sets the selected configuration part. More...

NXOpen::Expression *	UpdateTime ()
	Returns the update time. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 NXOpen::Mechatronics::MATLABClientBuilder
This class is sub-object of another builder, and cannot be directly instantiated.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::MATLABClientBuilder::DataPortType

Represents the data port type.

Enumerator
DataPortTypeInput	Input.
DataPortTypeOutput	Output.

enum NXOpen::Mechatronics::MATLABClientBuilder::DataType

Represents the data type.

Enumerator
DataTypeBool	bool
DataTypeInt	int
DataTypeDouble	double

Member Function Documentation

void NXOpen::Mechatronics::MATLABClientBuilder::GetAvailableItems	(	std::vector< NXString > &	signalName,
		std::vector< NXOpen::Mechatronics::MATLABClientBuilder::DataType > &	signalType
	)

Get the available MATLAB items.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

signalName	signalname
signalType	signaltype

void NXOpen::Mechatronics::MATLABClientBuilder::GetItemAttributes ( std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagAttribute > & attr )

Get the attribute of MATLAB items
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

attr attr

void NXOpen::Mechatronics::MATLABClientBuilder::GetMATLABInformation	(	const NXString &	instanceName,
		std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &	tagInfos
	)

Get the object information into MATLAB Data
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
tagInfos	Array of TagInfos

void NXOpen::Mechatronics::MATLABClientBuilder::GetMATLABInformation	(	const char *	instanceName,
		std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &	tagInfos
	)

Get the object information into MATLAB Data
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
tagInfos	Array of TagInfos

std::vector<NXOpen::Mechatronics::MATLABClientBuilder::TagInfo> NXOpen::Mechatronics::MATLABClientBuilder::GetServerTags ( const NXString & serverName )

Gets MATLAB instance Tags.

Returns: Array of TagInfos
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverName servername

std::vector<NXOpen::Mechatronics::MATLABClientBuilder::TagInfo> NXOpen::Mechatronics::MATLABClientBuilder::GetServerTags ( const char * serverName )

Gets MATLAB instance Tags.

Returns: Array of TagInfos
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverName servername

NXString NXOpen::Mechatronics::MATLABClientBuilder::MatlabFileBrowser ( )

Returns the simulink file browser.

Created in NX11.0.0.

License requirements : None

NXString NXOpen::Mechatronics::MATLABClientBuilder::MATLABServerProgID ( )

Returns the MATLAB server prog ID.

Created in NX11.0.0.

License requirements : None

NXString NXOpen::Mechatronics::MATLABClientBuilder::SelectedConfigurationName ( )

Returns the selected configuration name.

Created in NX12.0.0.

License requirements : None

NXOpen::Part* NXOpen::Mechatronics::MATLABClientBuilder::SelectedConfigurationPart ( )

Returns the selected configuration part.

Created in NX12.0.0.

License requirements : None

void NXOpen::Mechatronics::MATLABClientBuilder::SetAvailableItems	(	const std::vector< NXString > &	signalName,
		const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::DataType > &	signalType
	)

Set the available MATLAB items.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

signalName	signalname
signalType	signaltype

void NXOpen::Mechatronics::MATLABClientBuilder::SetItemAttributes ( const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagAttribute > & attr )

Set the attribute of MATLAB items
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

attr attr

void NXOpen::Mechatronics::MATLABClientBuilder::SetMatlabFileBrowser ( const NXString & filename )

Sets the simulink file browser.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

filename filename

void NXOpen::Mechatronics::MATLABClientBuilder::SetMatlabFileBrowser ( const char * filename )

Sets the simulink file browser.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

filename filename

void NXOpen::Mechatronics::MATLABClientBuilder::SetMATLABInformation	(	const NXString &	instanceName,
		const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &	tagInfos
	)

Set the object information into MATLAB Data.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
tagInfos	Array of TagInfos

void NXOpen::Mechatronics::MATLABClientBuilder::SetMATLABInformation	(	const char *	instanceName,
		const std::vector< NXOpen::Mechatronics::MATLABClientBuilder::TagInfo > &	tagInfos
	)

Set the object information into MATLAB Data.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
tagInfos	Array of TagInfos

void NXOpen::Mechatronics::MATLABClientBuilder::SetMATLABServerProgID ( const NXString & matlabServerProgID )

Sets the MATLAB server prog ID.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

matlabServerProgID matlabserverprogid

void NXOpen::Mechatronics::MATLABClientBuilder::SetMATLABServerProgID ( const char * matlabServerProgID )

Sets the MATLAB server prog ID.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

matlabServerProgID matlabserverprogid

void NXOpen::Mechatronics::MATLABClientBuilder::SetSelectedConfigurationName ( const NXString & configurationName )

Sets the selected configuration name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName configurationname

void NXOpen::Mechatronics::MATLABClientBuilder::SetSelectedConfigurationName ( const char * configurationName )

Sets the selected configuration name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName configurationname

void NXOpen::Mechatronics::MATLABClientBuilder::SetSelectedConfigurationPart ( NXOpen::Part * ownerPart )

Sets the selected configuration part.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ownerPart ownerpart

NXOpen::Expression* NXOpen::Mechatronics::MATLABClientBuilder::UpdateTime ( )

Returns the update time.

Created in NX11.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Mechatronics_MATLABClientBuilder.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation