Represents a NXOpen.Mechatronics.OPCClientBuilder More...

Inheritance diagram for NXOpen.Mechatronics.OPCClientBuilder:

Classes
struct	_TagAttribute
	the attribute of OPC item.

struct	_TagInfo
	Represents OPCDATag info definition structure.

struct	_TagInfoEx
	Represents Extended OPCDA Tag info definition structure.

struct	TagAttribute
	the attribute of OPC item. More...

struct	TagInfo
	Represents OPCDATag info definition structure. More...

struct	TagInfoEx
	Represents Extended OPCDA Tag info definition structure. More...

Public Types
enum	ServerOption { Local, Remote, InProc }
	the server option. More...

enum	TagAccess { ReadOnly = 1, WriteOnly, ReadWrite }
	the access right of OPC item. More...

enum	TagDataType { Unknown, Integer, Float, Boolean }
	the data type of OPC item. More...

Public Member Functions
unsafe void	AddTags ()
	Add item to the list. More...

unsafe void	DeleteTags ()
	Delete item from the list. More...

unsafe void	GetAvailableItems (out string[] tagName, out NXOpen.Mechatronics.OPCClientBuilder.TagDataType[] tagType)
	Get the available OPC items. More...

unsafe void	GetItemAttributes (out NXOpen.Mechatronics.OPCClientBuilder.TagAttribute[] attr)
	Get the attribute of OPC items More...

unsafe void	GetServerInfos (string serverName, NXOpen.Part ownerPart, out NXOpen.Mechatronics.OPCClientBuilder.TagInfo[] tagInfos)
	Gets OPC instance Info More...

unsafe string[]	GetServerNames ()
	Gets OPC instance names More...

unsafe NXOpen.Mechatronics.OPCClientBuilder.TagInfo[]	GetServerTags (string serverName)
	Gets OPC instance Tags More...

unsafe void	GetServerTagsEx (string serverName, out NXOpen.Mechatronics.OPCClientBuilder.TagInfoEx[] tagInfos)
	Gets OPC DA instance information More...

unsafe void	SetAvailableItems (string[] tagName, NXOpen.Mechatronics.OPCClientBuilder.TagDataType[] tagType)
	Set the available OPC items. More...

unsafe void	SetItemAttributes (NXOpen.Mechatronics.OPCClientBuilder.TagAttribute[] attr)
	Set the attribute of OPC items More...

unsafe void	SetServerInfos (string serverName, NXOpen.Part ownerPart, NXOpen.Mechatronics.OPCClientBuilder.TagInfo[] tagInfos)
	Sets OPC instance Tags More...

unsafe void	SetServerNames (string[] names)
	Sets OPC instance names More...

unsafe void	SetServerTagsEx (string serverName, NXOpen.Mechatronics.OPCClientBuilder.TagInfoEx[] tagInfos)
	Sets OPC DA instance information 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...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. 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...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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

enum NXOpen.Mechatronics.OPCClientBuilder.ServerOption

the server option.

Enumerator
Local	local server
Remote	remote server
InProc	in proc server

enum NXOpen.Mechatronics.OPCClientBuilder.TagAccess

the access right of OPC item.

Enumerator
ReadOnly	read only
WriteOnly	write only
ReadWrite	read and write

enum NXOpen.Mechatronics.OPCClientBuilder.TagDataType

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 ( )

inline

Add item to the list.

Created in NX8.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe void NXOpen.Mechatronics.OPCClientBuilder.DeleteTags ( )

inline

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
	)

inline

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 )

inline

Get the attribute of OPC items

Created in NX8.5.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

attr

unsafe void NXOpen.Mechatronics.OPCClientBuilder.GetServerInfos	(	string	serverName,
		NXOpen.Part	ownerPart,
		out NXOpen.Mechatronics.OPCClientBuilder.TagInfo[]	tagInfos
	)

inline

Gets OPC instance Info

Created in NX12.0.2

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

serverName
ownerPart
tagInfos	Array of TagInfos

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

inline

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 )

inline

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.GetServerTagsEx	(	string	serverName,
		out NXOpen.Mechatronics.OPCClientBuilder.TagInfoEx[]	tagInfos
	)

inline

Gets OPC DA instance information

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

serverName
tagInfos	Array of TagInfoExs

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

inline

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 )

inline

Set the attribute of OPC items

Created in NX8.5.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

attr

unsafe void NXOpen.Mechatronics.OPCClientBuilder.SetServerInfos	(	string	serverName,
		NXOpen.Part	ownerPart,
		NXOpen.Mechatronics.OPCClientBuilder.TagInfo[]	tagInfos
	)

inline

Sets OPC instance Tags

Created in NX12.0.2

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

serverName
ownerPart
tagInfos	Array of TagInfos

unsafe void NXOpen.Mechatronics.OPCClientBuilder.SetServerNames ( string[] names )

inline

Sets OPC instance names

Created in NX12.0.2

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

names

unsafe void NXOpen.Mechatronics.OPCClientBuilder.SetServerTagsEx	(	string	serverName,
		NXOpen.Mechatronics.OPCClientBuilder.TagInfoEx[]	tagInfos
	)

inline

Sets OPC DA instance information

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters

serverName
tagInfos	Array of TagInfoExs

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:

Mechatronics_OPCClientBuilder.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation