MCDSignalServerConfigurationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MCDSignalServerConfigurationBuilder Class

class `NXOpen.Mechatronics.``MCDSignalServerConfigurationBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.MCDSignalServerConfigurationBuilder`

  It is used to maintain all server builders for MCD signals. Such as SHM, TCP/UDP, etc.

  To create a new instance of this class, use `NXOpen.Mechatronics.MCDSignalServerConfigurationCollection.CreateMCDSignalServerConfigurationBuilder()`

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
SHMSignalProvider | Returns the SHMSignalProviderBuilder that holds the configuration for SHMSignalProvider.
TCPSignalServer | Returns the TCPSignalServerBuilder that holds the configuration for TCPSignalServer.
Tag | Returns the Tag for this object.
UDPSignalServer | Returns the UDPSignalServer builder that holds the configuration for UDPSignalServer.

# 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

## SHMSignalProvider

`MCDSignalServerConfigurationBuilder.``SHMSignalProvider`

  Returns the SHMSignalProviderBuilder that holds the configuration for SHMSignalProvider.

  `-------------------------------------`

  Getter Method

  Signature `SHMSignalProvider`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SHMSignalProviderBuilder`

  New in version NX12.0.0.

  License requirements: None.

## TCPSignalServer

`MCDSignalServerConfigurationBuilder.``TCPSignalServer`

  Returns the TCPSignalServerBuilder that holds the configuration for TCPSignalServer.

  `-------------------------------------`

  Getter Method

  Signature `TCPSignalServer`

  Returns: |
  Return type: | `NXOpen.Mechatronics.TCPSignalServerBuilder`

  New in version NX12.0.0.

  License requirements: None.

## UDPSignalServer

`MCDSignalServerConfigurationBuilder.``UDPSignalServer`

  Returns the UDPSignalServer builder that holds the configuration for UDPSignalServer.

  `-------------------------------------`

  Getter Method

  Signature `UDPSignalServer`

  Returns: |
  Return type: | `NXOpen.Mechatronics.UDPSignalServerBuilder`

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## Validate

`MCDSignalServerConfigurationBuilder.``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.