NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Mechatronics::MATLABSignalConnectionBuilder Class Reference

Represents a Mechatronics::MATLABSignalConnectionBuilder
To create a new instance of this class, use NXOpen::Mechatronics::MATLABSignalConnectionCollection::CreateSignalConnectionBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::Mechatronics::MATLABSignalConnectionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DataType {
  DataTypeUnknown, DataTypeInt, DataTypeDouble, DataTypeBool,
  DataTypeString
}
 Represents the OPC signal data type. More...
 

Public Member Functions

NXOpen::Mechatronics::SignalAdapterAdapterIdentify ()
 Returns the adapter object. More...
 
NXString MATLABSignalName ()
 Returns the MATLAB signal name. More...
 
NXOpen::Mechatronics::MATLABClientBuilder::DataPortType MATLABSignalPort ()
 Returns the MATLAB signal port type. More...
 
NXOpen::Mechatronics::MATLABSignalConnectionBuilder::DataType MATLABSignalType ()
 Returns the MATLAB signal type. More...
 
NXString ModelName ()
 Returns the matlab model name. More...
 
NXString ResultName ()
 Returns the mapping result name. More...
 
void SetAdapterIdentify (NXOpen::Mechatronics::SignalAdapter *adapterIdentify)
 Sets the adapter object. More...
 
void SetMATLABSignalName (const NXString &matlabsignalName)
 Sets the MATLAB signal name. More...
 
void SetMATLABSignalName (const char *matlabsignalName)
 Sets the MATLAB signal name. More...
 
void SetMATLABSignalPort (NXOpen::Mechatronics::MATLABClientBuilder::DataPortType matlabSignalPort)
 Sets the MATLAB signal port type. More...
 
void SetMATLABSignalType (NXOpen::Mechatronics::MATLABSignalConnectionBuilder::DataType matlabSignalType)
 Sets the MATLAB signal type. More...
 
void SetModelName (const NXString &modelName)
 Sets the matlab model name. More...
 
void SetModelName (const char *modelName)
 Sets the matlab model name. More...
 
void SetResultName (const NXString &resultName)
 Sets the mapping result name. More...
 
void SetResultName (const char *resultName)
 Sets the mapping result name. More...
 
void SetSignalIdentify (NXOpen::NXObject *signalIdentify)
 Sets the signal object. More...
 
void SetStreamIO (int streamIO)
 Sets the mapping direction. More...
 
NXOpen::NXObjectSignalIdentify ()
 Returns the signal object. More...
 
int StreamIO ()
 Returns the mapping direction. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 Mechatronics::MATLABSignalConnectionBuilder
To create a new instance of this class, use NXOpen::Mechatronics::MATLABSignalConnectionCollection::CreateSignalConnectionBuilder

Created in NX11.0.0.


Member Enumeration Documentation

Represents the OPC signal data type.

Enumerator
DataTypeUnknown 

unknown

DataTypeInt 

integer

DataTypeDouble 

float

DataTypeBool 

boolean

DataTypeString 

string

Member Function Documentation

NXOpen::Mechatronics::SignalAdapter* NXOpen::Mechatronics::MATLABSignalConnectionBuilder::AdapterIdentify ( )

Returns the adapter object.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::MATLABSignalConnectionBuilder::MATLABSignalName ( )

Returns the MATLAB signal name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::MATLABClientBuilder::DataPortType NXOpen::Mechatronics::MATLABSignalConnectionBuilder::MATLABSignalPort ( )

Returns the MATLAB signal port type.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::MATLABSignalConnectionBuilder::DataType NXOpen::Mechatronics::MATLABSignalConnectionBuilder::MATLABSignalType ( )

Returns the MATLAB signal type.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::MATLABSignalConnectionBuilder::ModelName ( )

Returns the matlab model name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::MATLABSignalConnectionBuilder::ResultName ( )

Returns the mapping result name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetAdapterIdentify ( NXOpen::Mechatronics::SignalAdapter adapterIdentify)

Sets the adapter object.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
adapterIdentifyadapteridentify
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetMATLABSignalName ( const NXString matlabsignalName)

Sets the MATLAB signal name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
matlabsignalNamematlabsignalname
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetMATLABSignalName ( const char *  matlabsignalName)

Sets the MATLAB signal name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
matlabsignalNamematlabsignalname
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetMATLABSignalPort ( NXOpen::Mechatronics::MATLABClientBuilder::DataPortType  matlabSignalPort)

Sets the MATLAB signal port type.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
matlabSignalPortmatlabsignalport
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetMATLABSignalType ( NXOpen::Mechatronics::MATLABSignalConnectionBuilder::DataType  matlabSignalType)

Sets the MATLAB signal type.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
matlabSignalTypematlabsignaltype
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetModelName ( const NXString modelName)

Sets the matlab model name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
modelNamemodelname
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetModelName ( const char *  modelName)

Sets the matlab model name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
modelNamemodelname
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetResultName ( const NXString resultName)

Sets the mapping result name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
resultNameresultname
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetResultName ( const char *  resultName)

Sets the mapping result name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
resultNameresultname
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetSignalIdentify ( NXOpen::NXObject signalIdentify)

Sets the signal object.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
signalIdentifysignalidentify
void NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SetStreamIO ( int  streamIO)

Sets the mapping direction.

0 represent input, 1 represent output
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
streamIOstreamio
NXOpen::NXObject* NXOpen::Mechatronics::MATLABSignalConnectionBuilder::SignalIdentify ( )

Returns the signal object.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::MATLABSignalConnectionBuilder::StreamIO ( )

Returns the mapping direction.

0 represent input, 1 represent output
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")


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