OPCUAClientBuilder Class

class NXOpen.Mechatronics.OPCUAClientBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.OPCUAClientBuilder 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.
GetObject	Returns the object currently being edited by this builder.
GetServerNames	Gets OPC UA instance names
GetServerTags	Gets OPC UA instance Tags
SetServerTags	Sets OPC UA instance Tags
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

OPCUAClientBuilderTagInfo_Struct Struct

Represents OPCUATag info definition structure.

Property Detail

SelectedConfigurationName

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

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

GetServerNames

OPCUAClientBuilder.GetServerNames

Gets OPC UA instance names

Signature GetServerNames()

Returns: Return type:list of str

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetServerTags

OPCUAClientBuilder.GetServerTags

Gets OPC UA instance Tags

Signature GetServerTags(serverName)

Parameters:serverName (str) – Returns:Array of TagInfos Return type:list of NXOpen.Mechatronics.OPCUAClientBuilderTagInfo_Struct

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetServerTags

OPCUAClientBuilder.SetServerTags

Sets OPC UA instance Tags

Signature SetServerTags(serverName, tagInfos)

Parameters:

• serverName (str) –
• tagInfos (list of NXOpen.Mechatronics.OPCUAClientBuilderTagInfo_Struct) – Array of TagInfos

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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