SignalMappingConnectionBuilder Class¶
-
class
NXOpen.Mechatronics.SignalMappingConnectionBuilder¶ Bases:
NXOpen.BuilderRepresents a
Mechatronics.SignalMappingConnectionBuilderTo create a new instance of this class, use
NXOpen.Mechatronics.SignalMappingConnectionCollection.CreateConnectionBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Adapter | Returns or sets the signal adapter object. |
| ClientType | Returns or sets the external signal client type. |
| ConfigurationName | Returns or sets the external signal configuration name. |
| ConfigurationPart | Returns or sets the external signal configuration part. |
| ConnectionName | Returns or sets the connection name. |
| ExternalSignalName | Returns or sets the external signal name. |
| Signal | Returns or sets the signal object. |
| 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. |
| 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. |
Property Detail¶
Adapter¶
-
SignalMappingConnectionBuilder.Adapter¶ Returns or sets the signal adapter object.
-------------------------------------Getter Method
Signature
AdapterReturns: Return type: NXOpen.Mechatronics.SignalAdapterNew in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
AdapterParameters: adapter ( NXOpen.Mechatronics.SignalAdapter) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ClientType¶
-
SignalMappingConnectionBuilder.ClientType¶ Returns or sets the external signal client type.
-------------------------------------Getter Method
Signature
ClientTypeReturns: Return type: NXOpen.Mechatronics.SignalMappingBuilderAppOptionNew in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
ClientTypeParameters: eClientType ( NXOpen.Mechatronics.SignalMappingBuilderAppOption) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ConfigurationName¶
-
SignalMappingConnectionBuilder.ConfigurationName¶ Returns or sets the external signal configuration name.
-------------------------------------Getter Method
Signature
ConfigurationNameReturns: Return type: str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
ConfigurationNameParameters: configurationName (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ConfigurationPart¶
-
SignalMappingConnectionBuilder.ConfigurationPart¶ Returns or sets the external signal configuration part.
-------------------------------------Getter Method
Signature
ConfigurationPartReturns: Return type: NXOpen.NXObjectNew in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
ConfigurationPartParameters: configurationPart ( NXOpen.NXObject) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ConnectionName¶
-
SignalMappingConnectionBuilder.ConnectionName¶ Returns or sets the connection name.
-------------------------------------Getter Method
Signature
ConnectionNameReturns: Return type: str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
ConnectionNameParameters: connectionName (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ExternalSignalName¶
-
SignalMappingConnectionBuilder.ExternalSignalName¶ Returns or sets the external signal name.
-------------------------------------Getter Method
Signature
ExternalSignalNameReturns: Return type: str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
ExternalSignalNameParameters: externalSignalName (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Signal¶
-
SignalMappingConnectionBuilder.Signal¶ Returns or sets the signal object.
-------------------------------------Getter Method
Signature
SignalReturns: Return type: NXOpen.NXObjectNew in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
SignalParameters: signal ( NXOpen.NXObject) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
SignalMappingConnectionBuilder.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.