SignalConnectionBuilder Class¶
-
class
NXOpen.Mechatronics.
SignalConnectionBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.SignalConnectionBuilder
To create a new instance of this class, use
NXOpen.Mechatronics.SignalConnectionCollection.CreateSignalConnectionBuilder
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
AdapterTag | Returns or sets the adapter object. |
OPCSignalAccess | Returns or sets the OPC access previlege type. |
OPCSignalName | Returns or sets the OPC signal name. |
OPCSignalType | Returns or sets the OPC signal type. |
ResultName | Returns or sets the mapping result name. |
SignalTag | Returns or sets the signal object. |
StreamIO | Returns or sets the mapping direction. |
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. |
Enumerations¶
SignalConnectionBuilderDataType Enumeration | Represents the OPC signal data type. |
Property Detail¶
AdapterTag¶
-
SignalConnectionBuilder.
AdapterTag
¶ Returns or sets the adapter object.
-------------------------------------
Getter Method
Signature
AdapterTag()
Returns: Return type: NXOpen.Mechatronics.SignalAdapter
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AdapterTag(adapterTag)
Parameters: adapterTag ( NXOpen.Mechatronics.SignalAdapter
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
OPCSignalAccess¶
-
SignalConnectionBuilder.
OPCSignalAccess
¶ Returns or sets the OPC access previlege type.
-------------------------------------
Getter Method
Signature
OPCSignalAccess()
Returns: Return type: NXOpen.Mechatronics.OPCClientBuilderTagAccess
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
OPCSignalAccess(oPCSignalAccess)
Parameters: oPCSignalAccess ( NXOpen.Mechatronics.OPCClientBuilderTagAccess
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
OPCSignalName¶
-
SignalConnectionBuilder.
OPCSignalName
¶ Returns or sets the OPC signal name.
-------------------------------------
Getter Method
Signature
OPCSignalName()
Returns: Return type: str New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
OPCSignalName(oPCsignalName)
Parameters: oPCsignalName (str) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
OPCSignalType¶
-
SignalConnectionBuilder.
OPCSignalType
¶ Returns or sets the OPC signal type.
-------------------------------------
Getter Method
Signature
OPCSignalType()
Returns: Return type: NXOpen.Mechatronics.SignalConnectionBuilderDataType
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
OPCSignalType(oPCSignalType)
Parameters: oPCSignalType ( NXOpen.Mechatronics.SignalConnectionBuilderDataType
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ResultName¶
-
SignalConnectionBuilder.
ResultName
¶ Returns or sets the mapping result name.
-------------------------------------
Getter Method
Signature
ResultName()
Returns: Return type: str New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
ResultName(resultName)
Parameters: resultName (str) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SignalTag¶
-
SignalConnectionBuilder.
SignalTag
¶ Returns or sets the signal object.
-------------------------------------
Getter Method
Signature
SignalTag()
Returns: Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
SignalTag(signalTag)
Parameters: signalTag ( NXOpen.NXObject
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
StreamIO¶
-
SignalConnectionBuilder.
StreamIO
¶ Returns or sets the mapping direction.
-------------------------------------
Getter Method
Signature
StreamIO()
Returns: Return type: int New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
StreamIO(streamIO)
Parameters: streamIO (int) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
SignalConnectionBuilder.
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.