TCPSignalServerBuilder Class¶
-
class
NXOpen.Mechatronics.
TCPSignalServerBuilder
¶ Bases:
NXOpen.Builder
Represents a
Mechatronics.TCPSignalServerBuilder
builder.This class is sub-object of another builder, and cannot be directly instantiated.
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
SelectedConfigurationName | Returns or sets the selected configuration name. |
Tag | Returns the Tag for this object. |
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. |
GetConnectionInformation | Gets connection information |
GetConnectionNames | Gets TCP connection names |
GetObject | Returns the object currently being edited by this builder. |
SetConnectionInformation | Sets connection information |
SetConnectionNames | Sets TCP connection names |
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. |
Structs¶
TCPSignalServerBuilderSignal_Struct Struct |
|
Property Detail¶
SelectedConfigurationName¶
-
TCPSignalServerBuilder.
SelectedConfigurationName
¶ Returns or sets the selected configuration name.
-------------------------------------
Getter Method
Signature
SelectedConfigurationName
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectedConfigurationName
Parameters: configurationName (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
GetConnectionInformation¶
-
TCPSignalServerBuilder.
GetConnectionInformation
¶ Gets connection information
Signature
GetConnectionInformation(connectionName)
Parameters: connectionName (str) – Returns: a tuple Return type: A tuple consisting of (remoteIP, remotePort, localIP, localPort, rcvBufSize, sendBufSize, updateTime, signals). remoteIP is a str. remotePort is a int. localIP is a str. localPort is a int. rcvBufSize is a int. sendBufSize is a int. updateTime is a float. signals is a list of NXOpen.Mechatronics.TCPSignalServerBuilderSignal_Struct
. Array of SignalNew in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
GetConnectionNames¶
-
TCPSignalServerBuilder.
GetConnectionNames
¶ Gets TCP connection names
Signature
GetConnectionNames()
Returns: Return type: list of str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetConnectionInformation¶
-
TCPSignalServerBuilder.
SetConnectionInformation
¶ Sets connection information
Signature
SetConnectionInformation(connectionName, remoteIP, remotePort, localIP, localPort, rcvBufSize, sendBufSize, updateTime, signals)
Parameters: - connectionName (str) –
- remoteIP (str) –
- remotePort (int) –
- localIP (str) –
- localPort (int) –
- rcvBufSize (int) –
- sendBufSize (int) –
- updateTime (float) –
- signals (list of
NXOpen.Mechatronics.TCPSignalServerBuilderSignal_Struct
) – Array of Signal
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetConnectionNames¶
-
TCPSignalServerBuilder.
SetConnectionNames
¶ Sets TCP connection names
Signature
SetConnectionNames(names)
Parameters: names (list of str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
TCPSignalServerBuilder.
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.