NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Mechatronics::OPCClientBuilder Class Reference

Represents a Mechatronics::OPCClientBuilder
To create a new instance of this class, use Mechatronics::PhysicsManager::CreateOpcclientBuilder

Created in NX8.0.0. More...

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

List of all members.

Public Types

enum  ServerOption { ServerOptionLocal, ServerOptionRemote, ServerOptionInProc }
 the server option. More...
enum  TagDataType { TagDataTypeUnknown, TagDataTypeInteger, TagDataTypeFloat, TagDataTypeBoolean }
 the data type of OPC tag. More...

Public Member Functions

void AddTags ()
 Add item to the list.
void DeleteTags ()
 Delete item from the list.
void GetAvailableItems (std::vector< NXString > &tagName, std::vector< NXOpen::Mechatronics::OPCClientBuilder::TagDataType > &tagType)
 Get the available OPC tags.
NXString HostName ()
 Returns the host name.
NXString OpcFileBrowser ()
 Returns the opc file browser.
NXString ServerProgID ()
 Returns the server prog ID.
NXOpen::Mechatronics::OPCClientBuilder::ServerOption ServerType ()
 Returns the server type.
void SetAvailableItems (const std::vector< NXString > &tagName, const std::vector< NXOpen::Mechatronics::OPCClientBuilder::TagDataType > &tagType)
 Set the available OPC tags.
void SetHostName (const NXString &hostName)
 Sets the host name.
void SetOpcFileBrowser (const NXString &filename)
 Sets the opc file browser.
void SetServerProgID (const NXString &serverProgID)
 Sets the server prog ID.
void SetServerType (NXOpen::Mechatronics::OPCClientBuilder::ServerOption serverType)
 Sets the server type.
NXOpen::ExpressionUpdateTime ()
 Returns the update time.

Detailed Description

Represents a Mechatronics::OPCClientBuilder
To create a new instance of this class, use Mechatronics::PhysicsManager::CreateOpcclientBuilder

Created in NX8.0.0.



Member Enumeration Documentation

the server option.

Enumerator:
ServerOptionLocal 

local server

ServerOptionRemote 

remote server

ServerOptionInProc 

in proc server

the data type of OPC tag.

Enumerator:
TagDataTypeUnknown 

unknown type

TagDataTypeInteger 

integer type

TagDataTypeFloat 

float type

TagDataTypeBoolean 

boolean type


Member Function Documentation

Add item to the list.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Delete item from the list.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Get the available OPC tags.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters:
tagNametagname
tagTypetagtype

Returns the host name.


Created in NX8.0.0.

License requirements : None

Returns the opc file browser.


Created in NX8.0.0.

License requirements : None

Returns the server prog ID.


Created in NX8.0.0.

License requirements : None

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


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters:
tagNametagname
tagTypetagtype

Sets the host name.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters:
hostNamehostname

Sets the opc file browser.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters:
filenamefilename

Sets the server prog ID.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters:
serverProgIDserverprogid

Sets the server type.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters:
serverTypeservertype

Returns the update time.


Created in NX8.0.0.

License requirements : None


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