SignalBuilder Class

class NXOpen.Mechatronics.SignalBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.SignalBuilder builder.

To create a new instance of this class, use NXOpen.Mechatronics.SignalCollection.CreateSignalBuilder()

New in version NX11.0.0.

Properties

Property Description
Name Returns or sets the 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.
GetObject Returns the object currently being edited by this builder.
GetSignalData Gets signal data.
SetSignalData Sets signal data.
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

SignalBuilderDataType Enumeration Represents the data type.
SignalBuilderExternalSignalIOType Enumeration Represents the external signal IO type.
SignalBuilderIOType Enumeration Represents the IO type.

Structs

SignalBuilderSignal_Struct Struct
Represents Signal definition structure.

Property Detail

Name

SignalBuilder.Name

Returns or sets the name.

The Signal name must be unique in the context of assembly and it should be selected from NXOpen.Mechatronics.SymbolTable.

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetSignalData

SignalBuilder.GetSignalData

Gets signal data.

Signature GetSignalData()

Returns:
Return type:NXOpen.Mechatronics.SignalBuilderSignal_Struct

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetSignalData

SignalBuilder.SetSignalData

Sets signal data.

Signature SetSignalData(signalData)

Parameters:signalData (NXOpen.Mechatronics.SignalBuilderSignal_Struct) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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