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

Represents a NXOpen::Mechatronics::SignalConnectionBuilder
To create a new instance of this class, use NXOpen::Mechatronics::SignalConnectionCollection::CreateSignalConnectionBuilder

Created in NX8.5.0. More...

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

Public Types

enum  DataType {
  DataTypeUnknown, DataTypeInteger, DataTypeFloat, DataTypeBoolean,
  DataTypeString
}
 Represents the OPC signal data type. More...
 

Public Member Functions

NXOpen::Mechatronics::SignalAdapterAdapterTag ()
 Returns the adapter object. More...
 
NXString OPCServerName ()
 Returns the opc Server
Created in NX11.0.0. More...
 
NXOpen::Mechatronics::OPCClientBuilder::TagAccess OPCSignalAccess ()
 Returns the OPC access previlege type. More...
 
NXString OPCSignalName ()
 Returns the OPC signal name. More...
 
NXOpen::Mechatronics::SignalConnectionBuilder::DataType OPCSignalType ()
 Returns the OPC signal type. More...
 
NXString ResultName ()
 Returns the mapping result name. More...
 
void SetAdapterTag (NXOpen::Mechatronics::SignalAdapter *adapterTag)
 Sets the adapter object. More...
 
void SetOPCServerName (const NXString &opcServerName)
 Sets the opc Server
Created in NX11.0.0. More...
 
void SetOPCServerName (const char *opcServerName)
 Sets the opc Server
Created in NX11.0.0. More...
 
void SetOPCSignalAccess (NXOpen::Mechatronics::OPCClientBuilder::TagAccess oPCSignalAccess)
 Sets the OPC access previlege type. More...
 
void SetOPCSignalName (const NXString &oPCsignalName)
 Sets the OPC signal name. More...
 
void SetOPCSignalName (const char *oPCsignalName)
 Sets the OPC signal name. More...
 
void SetOPCSignalType (NXOpen::Mechatronics::SignalConnectionBuilder::DataType oPCSignalType)
 Sets the OPC signal type. More...
 
void SetResultName (const NXString &resultName)
 Sets the mapping result name. More...
 
void SetResultName (const char *resultName)
 Sets the mapping result name. More...
 
void SetSignalTag (NXOpen::NXObject *signalTag)
 Sets the signal object. More...
 
void SetStreamIO (int streamIO)
 Sets the mapping direction. More...
 
NXOpen::NXObjectSignalTag ()
 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 NXOpen::Mechatronics::SignalConnectionBuilder
To create a new instance of this class, use NXOpen::Mechatronics::SignalConnectionCollection::CreateSignalConnectionBuilder

Created in NX8.5.0.


Member Enumeration Documentation

Represents the OPC signal data type.

Enumerator
DataTypeUnknown 

unknown

DataTypeInteger 

integer

DataTypeFloat 

float

DataTypeBoolean 

boolean

DataTypeString 

string

Member Function Documentation

NXOpen::Mechatronics::SignalAdapter* NXOpen::Mechatronics::SignalConnectionBuilder::AdapterTag ( )

Returns the adapter object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SignalConnectionBuilder::OPCServerName ( )

Returns the opc Server
Created in NX11.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::OPCClientBuilder::TagAccess NXOpen::Mechatronics::SignalConnectionBuilder::OPCSignalAccess ( )

Returns the OPC access previlege type.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SignalConnectionBuilder::OPCSignalName ( )

Returns the OPC signal name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SignalConnectionBuilder::DataType NXOpen::Mechatronics::SignalConnectionBuilder::OPCSignalType ( )

Returns the OPC signal type.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SignalConnectionBuilder::ResultName ( )

Returns the mapping result name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::SignalConnectionBuilder::SetAdapterTag ( NXOpen::Mechatronics::SignalAdapter adapterTag)

Sets the adapter object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
adapterTagadaptertag
void NXOpen::Mechatronics::SignalConnectionBuilder::SetOPCServerName ( const NXString opcServerName)

Sets the opc Server
Created in NX11.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
opcServerNameopcservername
void NXOpen::Mechatronics::SignalConnectionBuilder::SetOPCServerName ( const char *  opcServerName)

Sets the opc Server
Created in NX11.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
opcServerNameopcservername
void NXOpen::Mechatronics::SignalConnectionBuilder::SetOPCSignalAccess ( NXOpen::Mechatronics::OPCClientBuilder::TagAccess  oPCSignalAccess)

Sets the OPC access previlege type.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
oPCSignalAccessopcsignalaccess
void NXOpen::Mechatronics::SignalConnectionBuilder::SetOPCSignalName ( const NXString oPCsignalName)

Sets the OPC signal name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
oPCsignalNameopcsignalname
void NXOpen::Mechatronics::SignalConnectionBuilder::SetOPCSignalName ( const char *  oPCsignalName)

Sets the OPC signal name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
oPCsignalNameopcsignalname
void NXOpen::Mechatronics::SignalConnectionBuilder::SetOPCSignalType ( NXOpen::Mechatronics::SignalConnectionBuilder::DataType  oPCSignalType)

Sets the OPC signal type.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
oPCSignalTypeopcsignaltype
void NXOpen::Mechatronics::SignalConnectionBuilder::SetResultName ( const NXString resultName)

Sets the mapping result name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

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

Sets the mapping result name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
resultNameresultname
void NXOpen::Mechatronics::SignalConnectionBuilder::SetSignalTag ( NXOpen::NXObject signalTag)

Sets the signal object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
signalTagsignaltag
void NXOpen::Mechatronics::SignalConnectionBuilder::SetStreamIO ( int  streamIO)

Sets the mapping direction.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
streamIOstreamio
NXOpen::NXObject* NXOpen::Mechatronics::SignalConnectionBuilder::SignalTag ( )

Returns the signal object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::SignalConnectionBuilder::StreamIO ( )

Returns the mapping direction.


Created in NX8.5.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.