OPCClientBuilder Class¶
-
class
NXOpen.Mechatronics.OPCClientBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Mechatronics.OPCClientBuilderTo create a new instance of this class, use
NXOpen.Mechatronics.PhysicsManager.CreateOpcclientBuilder()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| HostName | Returns or sets the host name. |
| OpcFileBrowser | Returns or sets the opc file browser. |
| ServerProgID | Returns or sets the server prog ID. |
| ServerType | Returns or sets the server type. |
| Tag | Returns the Tag for this object. |
| UpdateTime | Returns the update time. |
Methods¶
| Method | Description |
|---|---|
| AddTags | Add item to the list. |
| Commit | Commits any edits that have been applied to the builder. |
| DeleteTags | Delete item from the list. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetAvailableItems | Get the available OPC items. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetItemAttributes | Get the attribute of OPC items |
| GetObject | Returns the object currently being edited by this builder. |
| SetAvailableItems | Set the available OPC items. |
| SetItemAttributes | Set the attribute of OPC items |
| 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¶
| OPCClientBuilderServerOption Enumeration | the server option. |
| OPCClientBuilderTagAccess Enumeration | the access right of OPC item. |
| OPCClientBuilderTagDataType Enumeration | the data type of OPC item. |
Structs¶
| OPCClientBuilderTagAttribute_Struct Struct | the attribute of OPC item. |
Property Detail¶
HostName¶
-
OPCClientBuilder.HostName¶ Returns or sets the host name.
-------------------------------------Getter Method
Signature
HostName()Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HostName(hostName)Parameters: hostName (str) – New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
OpcFileBrowser¶
-
OPCClientBuilder.OpcFileBrowser¶ Returns or sets the opc file browser.
-------------------------------------Getter Method
Signature
OpcFileBrowser()Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OpcFileBrowser(filename)Parameters: filename (str) – New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ServerProgID¶
-
OPCClientBuilder.ServerProgID¶ Returns or sets the server prog ID.
-------------------------------------Getter Method
Signature
ServerProgID()Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ServerProgID(serverProgID)Parameters: serverProgID (str) – New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ServerType¶
-
OPCClientBuilder.ServerType¶ Returns or sets the server type.
-------------------------------------Getter Method
Signature
ServerType()Returns: Return type: NXOpen.Mechatronics.OPCClientBuilderServerOptionNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ServerType(serverType)Parameters: serverType ( NXOpen.Mechatronics.OPCClientBuilderServerOption) –New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
UpdateTime¶
-
OPCClientBuilder.UpdateTime¶ Returns the update time.
-------------------------------------Getter Method
Signature
UpdateTime()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
Method Detail¶
AddTags¶
-
OPCClientBuilder.AddTags¶ Add item to the list.
Signature
AddTags()New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
DeleteTags¶
-
OPCClientBuilder.DeleteTags¶ Delete item from the list.
Signature
DeleteTags()New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
GetAvailableItems¶
-
OPCClientBuilder.GetAvailableItems¶ Get the available OPC items.
Signature
GetAvailableItems()Returns: a tuple Return type: A tuple consisting of (tagName, tagType). tagName is a list of str. tagType is a list of NXOpen.Mechatronics.OPCClientBuilderTagDataType.New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
GetItemAttributes¶
-
OPCClientBuilder.GetItemAttributes¶ Get the attribute of OPC items
Signature
GetItemAttributes()Returns: Return type: list of NXOpen.Mechatronics.OPCClientBuilderTagAttribute_StructNew in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetAvailableItems¶
-
OPCClientBuilder.SetAvailableItems¶ Set the available OPC items.
Signature
SetAvailableItems(tagName, tagType)Parameters: - tagName (list of str) –
- tagType (list of
NXOpen.Mechatronics.OPCClientBuilderTagDataType) –
New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetItemAttributes¶
-
OPCClientBuilder.SetItemAttributes¶ Set the attribute of OPC items
Signature
SetItemAttributes(attr)Parameters: attr (list of NXOpen.Mechatronics.OPCClientBuilderTagAttribute_Struct) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
OPCClientBuilder.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.