PlcSimAdvClientBuilder Class

class NXOpen.Mechatronics.PlcSimAdvClientBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.PlcSimAdvClientBuilder 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.
GetInstanceInformation Gets PLCSIMAdv instance information
GetInstanceNames Gets PLCSIMAdv instance names
GetObject Returns the object currently being edited by this builder.
RefreshRegisteredInstances Refresh registered PLCSIMAdv instances.
SetInstanceInformation Sets PLCSIMAdv instance information
SetInstanceNames Sets PLCSIMAdv instance 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.

Enumerations

PlcSimAdvClientBuilderAreaType Enumeration Represents the plc signal area type.

Structs

PlcSimAdvClientBuilderTagInfo_Struct Struct
Represents PLCTag info definition structure.

Property Detail

SelectedConfigurationName

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

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

GetInstanceInformation

PlcSimAdvClientBuilder.GetInstanceInformation

Gets PLCSIMAdv instance information

Signature GetInstanceInformation(instanceName, ownerPart)

Parameters:
Returns:

Array of TagInfos
Return type:

list of NXOpen.Mechatronics.PlcSimAdvClientBuilderTagInfo_Struct

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetInstanceNames

PlcSimAdvClientBuilder.GetInstanceNames

Gets PLCSIMAdv instance names

Signature GetInstanceNames()

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

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RefreshRegisteredInstances

PlcSimAdvClientBuilder.RefreshRegisteredInstances

Refresh registered PLCSIMAdv instances.

Signature RefreshRegisteredInstances()

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetInstanceInformation

PlcSimAdvClientBuilder.SetInstanceInformation

Sets PLCSIMAdv instance information

Signature SetInstanceInformation(instanceName, ownerPart, tagInfos)

Parameters:

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetInstanceNames

PlcSimAdvClientBuilder.SetInstanceNames

Sets PLCSIMAdv instance names

Signature SetInstanceNames(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

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