Represents a NXOpen::Mechatronics::OPCClientBuilder
This class is sub-object of another builder, and cannot be directly instantiated. More...

Inheritance diagram for NXOpen::Mechatronics::OPCClientBuilder:

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

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

Public Types
enum	ServerOption { ServerOptionLocal, ServerOptionRemote, ServerOptionInProc }
	the server option. More...

enum	TagAccess { TagAccessReadOnly = 1, TagAccessWriteOnly, TagAccessReadWrite }
	the access right of OPC item. More...

enum	TagDataType { TagDataTypeUnknown, TagDataTypeInteger, TagDataTypeFloat, TagDataTypeBoolean }
	the data type of OPC item. More...

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

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

void	GetAvailableItems (std::vector< NXString > &tagName, std::vector< NXOpen::Mechatronics::OPCClientBuilder::TagDataType > &tagType)
	Get the available OPC items. More...

void	GetItemAttributes (std::vector< NXOpen::Mechatronics::OPCClientBuilder::TagAttribute > &attr)
	Get the attribute of OPC items Created in NX8.5.0. More...

std::vector< NXString >	GetServerNames ()
	Gets OPC instance names. More...

std::vector < NXOpen::Mechatronics::OPCClientBuilder::TagInfo >	GetServerTags (const NXString &serverName)
	Gets OPC instance Tags. More...

std::vector < NXOpen::Mechatronics::OPCClientBuilder::TagInfo >	GetServerTags (const char *serverName)
	Gets OPC instance Tags. More...

NXString	HostName ()
	Returns the host name. More...

NXString	OpcFileBrowser ()
	Returns the opc file browser. More...

NXString	SelectedConfigurationName ()
	Returns. More...

NXOpen::Part *	SelectedConfigurationPart ()
	Returns. More...

NXString	ServerProgID ()
	Returns the server prog ID. More...

NXOpen::Mechatronics::OPCClientBuilder::ServerOption	ServerType ()
	Returns the server type. More...

void	SetAvailableItems (const std::vector< NXString > &tagName, const std::vector< NXOpen::Mechatronics::OPCClientBuilder::TagDataType > &tagType)
	Set the available OPC items. More...

void	SetHostName (const NXString &hostName)
	Sets the host name. More...

void	SetHostName (const char *hostName)
	Sets the host name. More...

void	SetItemAttributes (const std::vector< NXOpen::Mechatronics::OPCClientBuilder::TagAttribute > &attr)
	Set the attribute of OPC items Created in NX8.5.0. More...

void	SetOpcFileBrowser (const NXString &filename)
	Sets the opc file browser. More...

void	SetOpcFileBrowser (const char *filename)
	Sets the opc file browser. More...

void	SetSelectedConfigurationName (const NXString &configurationName)
	Sets. More...

void	SetSelectedConfigurationName (const char *configurationName)
	Sets. More...

void	SetSelectedConfigurationPart (NXOpen::Part *ownerPart)
	Sets. More...

void	SetServerProgID (const NXString &serverProgID)
	Sets the server prog ID. More...

void	SetServerProgID (const char *serverProgID)
	Sets the server prog ID. More...

void	SetServerType (NXOpen::Mechatronics::OPCClientBuilder::ServerOption serverType)
	Sets the server type. More...

NXOpen::Expression *	UpdateTime ()
	Returns the update time. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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
ServerOptionLocal	local server
ServerOptionRemote	remote server
ServerOptionInProc	in proc server

enum NXOpen::Mechatronics::OPCClientBuilder::TagAccess

the access right of OPC item.

Enumerator
TagAccessReadOnly	read only
TagAccessWriteOnly	write only
TagAccessReadWrite	read and write

enum NXOpen::Mechatronics::OPCClientBuilder::TagDataType

the data type of OPC item.

Enumerator
TagDataTypeUnknown	unknown type
TagDataTypeInteger	integer type
TagDataTypeFloat	float type
TagDataTypeBoolean	boolean type

Member Function Documentation

void NXOpen::Mechatronics::OPCClientBuilder::AddTags ( )

Add item to the list.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::OPCClientBuilder::DeleteTags ( )

Delete item from the list.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::OPCClientBuilder::GetAvailableItems	(	std::vector< NXString > &	tagName,
		std::vector< 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	tagname
tagType	tagtype

void NXOpen::Mechatronics::OPCClientBuilder::GetItemAttributes ( std::vector< 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 attr

std::vector<NXString> NXOpen::Mechatronics::OPCClientBuilder::GetServerNames ( )

Gets OPC instance names.

Returns: Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

std::vector<NXOpen::Mechatronics::OPCClientBuilder::TagInfo> NXOpen::Mechatronics::OPCClientBuilder::GetServerTags ( const NXString & serverName )

Gets OPC instance Tags.

Returns: Array of TagInfos
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverName servername

std::vector<NXOpen::Mechatronics::OPCClientBuilder::TagInfo> NXOpen::Mechatronics::OPCClientBuilder::GetServerTags ( const char * serverName )

Gets OPC instance Tags.

Returns: Array of TagInfos
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverName servername

NXString NXOpen::Mechatronics::OPCClientBuilder::HostName ( )

Returns the host name.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Mechatronics::OPCClientBuilder::OpcFileBrowser ( )

Returns the opc file browser.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Mechatronics::OPCClientBuilder::SelectedConfigurationName ( )

Returns.

the selected configuration name

Created in NX12.0.0.

License requirements : None

NXOpen::Part* NXOpen::Mechatronics::OPCClientBuilder::SelectedConfigurationPart ( )

Returns.

the selected configuration part

Created in NX12.0.0.

License requirements : None

NXString NXOpen::Mechatronics::OPCClientBuilder::ServerProgID ( )

Returns the server prog ID.

Created in NX8.0.0.

License requirements : None

NXOpen::Mechatronics::OPCClientBuilder::ServerOption NXOpen::Mechatronics::OPCClientBuilder::ServerType ( )

Returns the server type.

Created in NX8.0.0.

License requirements : None

void NXOpen::Mechatronics::OPCClientBuilder::SetAvailableItems	(	const std::vector< NXString > &	tagName,
		const std::vector< 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	tagname
tagType	tagtype

void NXOpen::Mechatronics::OPCClientBuilder::SetHostName ( const NXString & hostName )

Sets the host name.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

hostName hostname

void NXOpen::Mechatronics::OPCClientBuilder::SetHostName ( const char * hostName )

Sets the host name.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

hostName hostname

void NXOpen::Mechatronics::OPCClientBuilder::SetItemAttributes ( const std::vector< 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 attr

void NXOpen::Mechatronics::OPCClientBuilder::SetOpcFileBrowser ( const NXString & filename )

Sets the opc file browser.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

filename filename

void NXOpen::Mechatronics::OPCClientBuilder::SetOpcFileBrowser ( const char * filename )

Sets the opc file browser.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

filename filename

void NXOpen::Mechatronics::OPCClientBuilder::SetSelectedConfigurationName ( const NXString & configurationName )

Sets.

the selected configuration name

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName configurationname

void NXOpen::Mechatronics::OPCClientBuilder::SetSelectedConfigurationName ( const char * configurationName )

Sets.

the selected configuration name

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName configurationname

void NXOpen::Mechatronics::OPCClientBuilder::SetSelectedConfigurationPart ( NXOpen::Part * ownerPart )

Sets.

the selected configuration part

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ownerPart ownerpart

void NXOpen::Mechatronics::OPCClientBuilder::SetServerProgID ( const NXString & serverProgID )

Sets the server prog ID.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverProgID serverprogid

void NXOpen::Mechatronics::OPCClientBuilder::SetServerProgID ( const char * serverProgID )

Sets the server prog ID.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverProgID serverprogid

void NXOpen::Mechatronics::OPCClientBuilder::SetServerType ( NXOpen::Mechatronics::OPCClientBuilder::ServerOption serverType )

Sets the server type.

Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

serverType servertype

NXOpen::Expression* NXOpen::Mechatronics::OPCClientBuilder::UpdateTime ( )

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.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation