NXOpen .NET Reference  12.0.0
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.Mechatronics.OPCClientBuilder Class Reference

Represents a NXOpen.Mechatronics.OPCClientBuilder More...

Inheritance diagram for NXOpen.Mechatronics.OPCClientBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Classes

struct  _TagAttribute
 the attribute of OPC item.
 
struct  _TagInfo
 Represents OPCUATag info definition structure.
 
struct  TagAttribute
 the attribute of OPC item. More...
 
struct  TagInfo
 Represents OPCUATag info definition structure. More...
 

Public Types

enum  ServerOption { Local, Remote, InProc }
 the server option. More...
 
enum  TagDataType { Unknown, Integer, Float, Boolean }
 the data type of OPC item. More...
 
enum  TagAccess { ReadOnly = 1, WriteOnly, ReadWrite }
 the access right of OPC item. More...
 

Public Member Functions

unsafe void DeleteTags ()
 Delete item from the list. More...
 
unsafe void AddTags ()
 Add item to the list. More...
 
unsafe void GetAvailableItems (out string[] tagName, out NXOpen.Mechatronics.OPCClientBuilder.TagDataType[] tagType)
 Get the available OPC items. More...
 
unsafe void SetAvailableItems (string[] tagName, NXOpen.Mechatronics.OPCClientBuilder.TagDataType[] tagType)
 Set the available OPC items. More...
 
unsafe void GetItemAttributes (out NXOpen.Mechatronics.OPCClientBuilder.TagAttribute[] attr)
 Get the attribute of OPC items More...
 
unsafe void SetItemAttributes (NXOpen.Mechatronics.OPCClientBuilder.TagAttribute[] attr)
 Set the attribute of OPC items More...
 
unsafe string[] GetServerNames ()
 Gets OPC instance names More...
 
unsafe
NXOpen.Mechatronics.OPCClientBuilder.TagInfo[] 
GetServerTags (string serverName)
 Gets OPC instance Tags More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe string HostName [get, set]
 Returns or sets the host name. More...
 
unsafe string OpcFileBrowser [get, set]
 Returns or sets the opc file browser. More...
 
unsafe string SelectedConfigurationName [get, set]
 Returns or sets the selected configuration name More...
 
unsafe NXOpen.Part SelectedConfigurationPart [get, set]
 Returns or sets the selected configuration part More...
 
unsafe string ServerProgID [get, set]
 Returns or sets the server prog ID. More...
 
unsafe
NXOpen.Mechatronics.OPCClientBuilder.ServerOption 
ServerType [get, set]
 Returns or sets the server type. More...
 
unsafe NXOpen.Expression UpdateTime [get]
 Returns the update time. More...
 

Detailed Description

Represents a NXOpen.Mechatronics.OPCClientBuilder

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

Created in NX8.0.0

Member Enumeration Documentation

the server option.

Enumerator
Local 

local server

Remote 

remote server

InProc 

in proc server

the access right of OPC item.

Enumerator
ReadOnly 

read only

WriteOnly 

write only

ReadWrite 

read and write

the data type of OPC item.

Enumerator
Unknown 

unknown type

Integer 

integer type

Float 

float type

Boolean 

boolean type

Member Function Documentation

unsafe void NXOpen.Mechatronics.OPCClientBuilder.AddTags ( )

Add item to the list.

Created in NX8.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe void NXOpen.Mechatronics.OPCClientBuilder.DeleteTags ( )

Delete item from the list.

Created in NX8.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe void NXOpen.Mechatronics.OPCClientBuilder.GetAvailableItems ( out string[]  tagName,
out NXOpen.Mechatronics.OPCClientBuilder.TagDataType[]  tagType 
)

Get the available OPC items.

Created in NX8.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
tagName
tagType
unsafe void NXOpen.Mechatronics.OPCClientBuilder.GetItemAttributes ( out NXOpen.Mechatronics.OPCClientBuilder.TagAttribute[]  attr)

Get the attribute of OPC items

Created in NX8.5.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
attr
unsafe string [] NXOpen.Mechatronics.OPCClientBuilder.GetServerNames ( )

Gets OPC instance names

Created in NX12.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Returns
unsafe NXOpen.Mechatronics.OPCClientBuilder.TagInfo [] NXOpen.Mechatronics.OPCClientBuilder.GetServerTags ( string  serverName)

Gets OPC instance Tags

Created in NX12.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
serverName
Returns
Array of TagInfos
unsafe void NXOpen.Mechatronics.OPCClientBuilder.SetAvailableItems ( string[]  tagName,
NXOpen.Mechatronics.OPCClientBuilder.TagDataType[]  tagType 
)

Set the available OPC items.

Created in NX8.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
tagName
tagType
unsafe void NXOpen.Mechatronics.OPCClientBuilder.SetItemAttributes ( NXOpen.Mechatronics.OPCClientBuilder.TagAttribute[]  attr)

Set the attribute of OPC items

Created in NX8.5.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
attr

Property Documentation

unsafe string NXOpen.Mechatronics.OPCClientBuilder.HostName
getset

Returns or sets the host name.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe string NXOpen.Mechatronics.OPCClientBuilder.OpcFileBrowser
getset

Returns or sets the opc file browser.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe string NXOpen.Mechatronics.OPCClientBuilder.SelectedConfigurationName
getset

Returns or sets the selected configuration name

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe NXOpen.Part NXOpen.Mechatronics.OPCClientBuilder.SelectedConfigurationPart
getset

Returns or sets the selected configuration part

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe string NXOpen.Mechatronics.OPCClientBuilder.ServerProgID
getset

Returns or sets the server prog ID.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe NXOpen.Mechatronics.OPCClientBuilder.ServerOption NXOpen.Mechatronics.OPCClientBuilder.ServerType
getset

Returns or sets the server type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe NXOpen.Expression NXOpen.Mechatronics.OPCClientBuilder.UpdateTime
get

Returns the update time.

Created in NX8.0.0

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.