ExternalSignalConfigurationBuilder Class¶
-
class
NXOpen.Mechatronics.
ExternalSignalConfigurationBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.ExternalSignalConfigurationBuilder
It is used to maintain all client builders for external signals. Such as OPC DA, OPC UA, SHM, TCP/UDP, PLCSIMAdv, etc.
To create a new instance of this class, use
NXOpen.Mechatronics.ExternalSignalConfigurationCollection.CreateExternalSignalConfigurationBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
MatlabClient | Returns the Matlab builder that holds the configuration for Matlab clients. |
OPCDAClient | Returns the OPC DA builder that holds the configuration for OPC DA clients. |
OPCUAClient | Returns the OPC UA builder that holds the configuration for OPC UA clients. |
PlcSimAdvClient | Returns the PLCSIMAdv builder that holds the configuration for PLCSIMAdv clients. |
ProfinetClient | Returns the Profinet builder that holds the configuration for Profinet clients. |
ShmClient | Returns the SHM builder that holds the configuration for SHM clients. |
Tag | Returns the Tag for this object. |
TcpClient | Returns the TCP builder that holds the configuration for TCP clients. |
UdpClient | Returns the UDP builder that holds the configuration for UDP clients. |
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. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
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. |
Property Detail¶
MatlabClient¶
-
ExternalSignalConfigurationBuilder.
MatlabClient
¶ Returns the Matlab builder that holds the configuration for Matlab clients.
-------------------------------------
Getter Method
Signature
MatlabClient
Returns: Return type: NXOpen.Mechatronics.MATLABClientBuilder
New in version NX12.0.0.
License requirements: None.
OPCDAClient¶
-
ExternalSignalConfigurationBuilder.
OPCDAClient
¶ Returns the OPC DA builder that holds the configuration for OPC DA clients.
-------------------------------------
Getter Method
Signature
OPCDAClient
Returns: Return type: NXOpen.Mechatronics.OPCClientBuilder
New in version NX12.0.0.
License requirements: None.
OPCUAClient¶
-
ExternalSignalConfigurationBuilder.
OPCUAClient
¶ Returns the OPC UA builder that holds the configuration for OPC UA clients.
-------------------------------------
Getter Method
Signature
OPCUAClient
Returns: Return type: NXOpen.Mechatronics.OPCUAClientBuilder
New in version NX12.0.0.
License requirements: None.
PlcSimAdvClient¶
-
ExternalSignalConfigurationBuilder.
PlcSimAdvClient
¶ Returns the PLCSIMAdv builder that holds the configuration for PLCSIMAdv clients.
-------------------------------------
Getter Method
Signature
PlcSimAdvClient
Returns: Return type: NXOpen.Mechatronics.PlcSimAdvClientBuilder
New in version NX12.0.0.
License requirements: None.
ProfinetClient¶
-
ExternalSignalConfigurationBuilder.
ProfinetClient
¶ Returns the Profinet builder that holds the configuration for Profinet clients.
-------------------------------------
Getter Method
Signature
ProfinetClient
Returns: Return type: NXOpen.Mechatronics.ProfinetClientBuilder
New in version NX12.0.0.
License requirements: None.
ShmClient¶
-
ExternalSignalConfigurationBuilder.
ShmClient
¶ Returns the SHM builder that holds the configuration for SHM clients.
-------------------------------------
Getter Method
Signature
ShmClient
Returns: Return type: NXOpen.Mechatronics.SHMSignalClientBuilder
New in version NX12.0.0.
License requirements: None.
TcpClient¶
-
ExternalSignalConfigurationBuilder.
TcpClient
¶ Returns the TCP builder that holds the configuration for TCP clients.
-------------------------------------
Getter Method
Signature
TcpClient
Returns: Return type: NXOpen.Mechatronics.TCPClientBuilder
New in version NX12.0.0.
License requirements: None.
UdpClient¶
-
ExternalSignalConfigurationBuilder.
UdpClient
¶ Returns the UDP builder that holds the configuration for UDP clients.
-------------------------------------
Getter Method
Signature
UdpClient
Returns: Return type: NXOpen.Mechatronics.UDPSignalClientBuilder
New in version NX12.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ExternalSignalConfigurationBuilder.
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.