TCPClientBuilder Class

class NXOpen.Mechatronics.TCPClientBuilder

Bases: NXOpen.Builder

Represents a Mechatronics.TCPClientBuilder 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.
SelectedConfigurationPart Returns or sets the selected configuration part.
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 TCP connection information
GetConnectionNames Gets TCP connection names
GetObject Returns the object currently being edited by this builder.
SetConnectionInformation Sets TCP 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

TCPClientBuilderSignal_Struct Struct
Represents TCP signal definition structure.

Property Detail

SelectedConfigurationName

TCPClientBuilder.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 NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectedConfigurationPart

TCPClientBuilder.SelectedConfigurationPart

Returns or sets the selected configuration part.

-------------------------------------

Getter Method

Signature SelectedConfigurationPart

Returns:
Return type:NXOpen.Part

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SelectedConfigurationPart

Parameters:ownerPart (NXOpen.Part) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetConnectionInformation

TCPClientBuilder.GetConnectionInformation

Gets TCP connection information

Signature GetConnectionInformation(instanceName, ownerPart)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (remoteIP, remotePort, localIP, rcvBufSize, sendBufSize, updateTime, signals). remoteIP is a str. remotePort is a int. localIP is a str. rcvBufSize is a int. sendBufSize is a int. updateTime is a float. signals is a list of NXOpen.Mechatronics.TCPClientBuilderSignal_Struct. Array of Signal

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetConnectionNames

TCPClientBuilder.GetConnectionNames

Gets TCP connection names

Signature GetConnectionNames()

Returns:a tuple
Return type:A tuple consisting of (ownerParts, names). ownerParts is a list of NXOpen.Part. names is a list of str.

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetConnectionInformation

TCPClientBuilder.SetConnectionInformation

Sets TCP connection information

Signature SetConnectionInformation(instanceName, ownerPart, remoteIP, remotePort, localIP, rcvBufSize, sendBufSize, updateTime, signals)

Parameters:

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetConnectionNames

TCPClientBuilder.SetConnectionNames

Sets TCP connection names

Signature SetConnectionNames(ownerParts, names)

Parameters:
  • ownerParts (list of NXOpen.Part) –
  • names (list of str) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

TCPClientBuilder.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.