ProfinetClientBuilder Class

class NXOpen.Mechatronics.ProfinetClientBuilder

Bases: NXOpen.Builder

Represents a Mechatronics.ProfinetClientBuilder builder

This class is sub-object of another builder, and cannot be directly instantiated.

New in version NX12.0.0.

Properties

Property	Description
InstanceName	Returns or sets the instance name
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.
GetTags	Get Profinet Client Infomation
SetTags	Set Profinet Client Infomation
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

ProfinetClientBuilderTagInfo_Struct Struct

Represents Profinet signal definition structure.

Property Detail

InstanceName

ProfinetClientBuilder.InstanceName

Returns or sets the instance name

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

Getter Method

Signature InstanceName

Returns: Return type:str

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature InstanceName

Parameters:name (str) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectedConfigurationName

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

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

GetTags

ProfinetClientBuilder.GetTags

Get Profinet Client Infomation

Signature GetTags()

Returns: Return type:list of NXOpen.Mechatronics.ProfinetClientBuilderTagInfo_Struct

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetTags

ProfinetClientBuilder.SetTags

Set Profinet Client Infomation

Signature SetTags(tagInfos)

Parameters:tagInfos (list of NXOpen.Mechatronics.ProfinetClientBuilderTagInfo_Struct) – Array of TagInfos

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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